From 73d151361b277d7fd8dad0c341c6ef17a1dcf74f Mon Sep 17 00:00:00 2001 From: Bastian Germann Date: Tue, 17 Feb 2026 23:47:41 +0100 Subject: [PATCH] Import bibletime_3.2.0.orig.tar.xz [dgit import orig bibletime_3.2.0.orig.tar.xz] --- CMakeLists.txt | 201 + CODE_OF_CONDUCT.md | 8 + FILE_HEADER.cpp.in | 12 + LICENSE | 339 ++ README.md | 77 + cmake/BTApplication.cmake | 252 + cmake/BTBinaryPackageWindows.cmake | 100 + cmake/BTDocumentation.cmake | 348 ++ cmake/BTWinIcon.rc | 1 + cmake/docs/docs.xsl.in | 9 + cmake/docs/pdf.xsl.in | 4 + cmake/fix_cpp_header.sh | 57 + cmake/platforms/linux/bibletime.desktop.cmake | 26 + .../info.bibletime.BibleTime.metainfo.xml | 32 + cmake/sword_version_print.cpp | 27 + docs/.gitignore | 1 + docs/Doxyfile | 2493 ++++++++ docs/handbook/docbook/hdbk-config.docbook | 215 + docs/handbook/docbook/hdbk-intro.docbook | 99 + docs/handbook/docbook/hdbk-operation.docbook | 461 ++ docs/handbook/docbook/hdbk-reference.docbook | 1459 +++++ docs/handbook/docbook/hdbk-start.docbook | 78 + docs/handbook/docbook/index.docbook | 90 + docs/handbook/images/i_back.png | Bin 0 -> 1427 bytes docs/handbook/images/i_bible.png | Bin 0 -> 1496 bytes docs/handbook/images/i_bible_add.png | Bin 0 -> 1611 bytes docs/handbook/images/i_bibletime.png | Bin 0 -> 1536 bytes docs/handbook/images/i_book.png | Bin 0 -> 1482 bytes docs/handbook/images/i_book_add.png | Bin 0 -> 1590 bytes docs/handbook/images/i_bookmark.png | Bin 0 -> 1404 bytes docs/handbook/images/i_books.png | Bin 0 -> 1427 bytes docs/handbook/images/i_cascade.png | Bin 0 -> 1382 bytes docs/handbook/images/i_checkbox.png | Bin 0 -> 1403 bytes docs/handbook/images/i_commentary.png | Bin 0 -> 1507 bytes docs/handbook/images/i_commentary_add.png | Bin 0 -> 1603 bytes docs/handbook/images/i_configure.png | Bin 0 -> 1255 bytes docs/handbook/images/i_configuresword.png | Bin 0 -> 1475 bytes docs/handbook/images/i_contents2.png | Bin 0 -> 1382 bytes docs/handbook/images/i_displayconfig.png | Bin 0 -> 1531 bytes docs/handbook/images/i_document_magnifier.png | Bin 0 -> 1469 bytes docs/handbook/images/i_exit.png | Bin 0 -> 1422 bytes docs/handbook/images/i_fileclose.png | Bin 0 -> 861 bytes docs/handbook/images/i_find.png | Bin 0 -> 1350 bytes docs/handbook/images/i_folder_open.png | Bin 0 -> 760 bytes docs/handbook/images/i_forward.png | Bin 0 -> 1459 bytes docs/handbook/images/i_lexicon.png | Bin 0 -> 1511 bytes docs/handbook/images/i_lexicon_add.png | Bin 0 -> 1611 bytes docs/handbook/images/i_light_bulb.png | Bin 0 -> 1292 bytes docs/handbook/images/i_sync.png | Bin 0 -> 1610 bytes docs/handbook/images/i_tile.png | Bin 0 -> 1432 bytes docs/handbook/images/i_tile_horiz.png | Bin 0 -> 415 bytes docs/handbook/images/i_tile_vert.png | Bin 0 -> 409 bytes docs/handbook/images/i_view_index.png | Bin 0 -> 313 bytes docs/handbook/images/i_view_mag.png | Bin 0 -> 303 bytes docs/handbook/images/i_window_fullscreen.png | Bin 0 -> 889 bytes docs/handbook/images/ss_configfonts.png | Bin 0 -> 22491 bytes docs/handbook/images/ss_mainterms.png | Bin 0 -> 90155 bytes docs/handbook/images/ss_searchanal.png | Bin 0 -> 14117 bytes docs/handbook/images/ss_searchopts.png | Bin 0 -> 39772 bytes docs/handbook/images/ss_shortcuts.png | Bin 0 -> 23323 bytes docs/howto/docbook/howto-basics.docbook | 274 + docs/howto/docbook/howto-importance.docbook | 351 ++ .../docbook/howto-interpretation.docbook | 329 ++ docs/howto/docbook/index.docbook | 58 + i18n/handbook/handbook-ar.po | 2768 +++++++++ i18n/handbook/handbook-br.po | 2518 ++++++++ i18n/handbook/handbook-cs.po | 2578 ++++++++ i18n/handbook/handbook-de.po | 2916 +++++++++ i18n/handbook/handbook-es.po | 2971 ++++++++++ i18n/handbook/handbook-fi.po | 2907 +++++++++ i18n/handbook/handbook-fr.po | 2924 +++++++++ i18n/handbook/handbook-hu.po | 2868 +++++++++ i18n/handbook/handbook-it.po | 2950 ++++++++++ i18n/handbook/handbook-ko.po | 2825 +++++++++ i18n/handbook/handbook-lt.po | 2651 +++++++++ i18n/handbook/handbook-nl.po | 2341 ++++++++ i18n/handbook/handbook-pt_BR.po | 2941 ++++++++++ i18n/handbook/handbook-ru.po | 2447 ++++++++ i18n/handbook/handbook-th.po | 2357 ++++++++ i18n/handbook/handbook-uk.po | 2657 +++++++++ i18n/handbook/handbook.pot | 2259 +++++++ i18n/howto/howto-ar.po | 1482 +++++ i18n/howto/howto-bg.po | 1457 +++++ i18n/howto/howto-br.po | 1430 +++++ i18n/howto/howto-cs.po | 1457 +++++ i18n/howto/howto-da.po | 1498 +++++ i18n/howto/howto-de.po | 1540 +++++ i18n/howto/howto-es.po | 1870 ++++++ i18n/howto/howto-fi.po | 1830 ++++++ i18n/howto/howto-fr.po | 1874 ++++++ i18n/howto/howto-hu.po | 1513 +++++ i18n/howto/howto-it.po | 1850 ++++++ i18n/howto/howto-ja.po | 1833 ++++++ i18n/howto/howto-ko.po | 1785 ++++++ i18n/howto/howto-lt.po | 1457 +++++ i18n/howto/howto-nl.po | 1543 +++++ i18n/howto/howto-pt_BR.po | 1571 +++++ i18n/howto/howto-ru.po | 1815 ++++++ i18n/howto/howto-th.po | 1434 +++++ i18n/howto/howto-uk.po | 1819 ++++++ i18n/howto/howto.pot | 1428 +++++ i18n/messages/bibletime_translate.qrc | 22 + i18n/messages/bibletime_ui.ts | 5042 ++++++++++++++++ i18n/messages/bibletime_ui_ar.ts | 5123 ++++++++++++++++ i18n/messages/bibletime_ui_br.ts | 5121 ++++++++++++++++ i18n/messages/bibletime_ui_cs.ts | 5124 ++++++++++++++++ i18n/messages/bibletime_ui_da.ts | 5119 ++++++++++++++++ i18n/messages/bibletime_ui_de.ts | 5123 ++++++++++++++++ i18n/messages/bibletime_ui_en_GB.ts | 5119 ++++++++++++++++ i18n/messages/bibletime_ui_es.ts | 5223 +++++++++++++++++ i18n/messages/bibletime_ui_et.ts | 5123 ++++++++++++++++ i18n/messages/bibletime_ui_fi.ts | 5220 ++++++++++++++++ i18n/messages/bibletime_ui_fr.ts | 5123 ++++++++++++++++ i18n/messages/bibletime_ui_hu.ts | 5168 ++++++++++++++++ i18n/messages/bibletime_ui_it.ts | 5220 ++++++++++++++++ i18n/messages/bibletime_ui_ja.ts | 5116 ++++++++++++++++ i18n/messages/bibletime_ui_ko.ts | 5122 ++++++++++++++++ i18n/messages/bibletime_ui_lt.ts | 5124 ++++++++++++++++ i18n/messages/bibletime_ui_lv.ts | 5118 ++++++++++++++++ i18n/messages/bibletime_ui_nl.ts | 5123 ++++++++++++++++ i18n/messages/bibletime_ui_pl.ts | 5120 ++++++++++++++++ i18n/messages/bibletime_ui_pt.ts | 5123 ++++++++++++++++ i18n/messages/bibletime_ui_pt_BR.ts | 5123 ++++++++++++++++ i18n/messages/bibletime_ui_ru.ts | 5127 ++++++++++++++++ i18n/messages/bibletime_ui_sk.ts | 5124 ++++++++++++++++ i18n/messages/bibletime_ui_th.ts | 5113 ++++++++++++++++ i18n/messages/bibletime_ui_uk.ts | 5124 ++++++++++++++++ i18n/messages/bibletime_ui_zh_TW.ts | 5125 ++++++++++++++++ i18n/messages/test_translate.qrc | 6 + pics/icons/LICENSE | 10 + pics/icons/add.svg | 1 + pics/icons/automatically.svg | 1 + pics/icons/back.svg | 1 + pics/icons/bible.svg | 1 + pics/icons/bibletime.ico | Bin 0 -> 11942 bytes pics/icons/bibletime.png | Bin 0 -> 4798 bytes pics/icons/bibletime.svg | 1 + pics/icons/book.svg | 1 + pics/icons/bookmark.svg | 1 + pics/icons/books.svg | 1 + pics/icons/calendar.svg | 1 + pics/icons/cascade.svg | 1 + pics/icons/checkbox.svg | 1 + pics/icons/commentary.svg | 1 + pics/icons/configure.svg | 1 + pics/icons/contents2.svg | 1 + pics/icons/delete.svg | 1 + pics/icons/dictionary.svg | 1 + pics/icons/displayconfig.svg | 1 + pics/icons/document_magnifier.svg | 1 + pics/icons/edit_clear_locationbar.svg | 1 + pics/icons/edit_copy.svg | 1 + pics/icons/exit.svg | 1 + pics/icons/export.svg | 1 + pics/icons/file_save.svg | 646 ++ pics/icons/fileclose.svg | 1 + pics/icons/find.svg | 2922 +++++++++ pics/icons/flag.svg | 1 + pics/icons/folder-open.svg | 1 + pics/icons/folder.svg | 1 + pics/icons/fonts.svg | 1 + pics/icons/forward.svg | 1 + pics/icons/import.svg | 1 + pics/icons/info.svg | 1 + pics/icons/key_bindings.svg | 3264 ++++++++++ pics/icons/layer-visible-on.svg | 1 + pics/icons/lexicon.svg | 1 + pics/icons/light_bulb.svg | 1 + pics/icons/lock.svg | 1 + pics/icons/manual.svg | 1 + pics/icons/map.svg | 1 + pics/icons/plus.svg | 1 + pics/icons/pointing_arrow.svg | 1 + pics/icons/print.svg | 1 + pics/icons/questionable.svg | 1 + pics/icons/remove.svg | 1 + pics/icons/speaker.svg | 31 + pics/icons/startconfig.svg | 1 + pics/icons/stop.svg | 1 + pics/icons/swordconfig.svg | 1 + pics/icons/sync.svg | 1 + pics/icons/tabbed.svg | 1 + pics/icons/text_bold.svg | 1 + pics/icons/text_center.svg | 1 + pics/icons/text_italic.svg | 1 + pics/icons/text_leftalign.svg | 1 + pics/icons/text_rightalign.svg | 1 + pics/icons/text_under.svg | 1 + pics/icons/tile.svg | 1 + pics/icons/tile_horiz.svg | 1 + pics/icons/tile_vert.svg | 1 + pics/icons/trash.svg | 1 + pics/icons/unlock.svg | 1 + pics/icons/view-tree.svg | 1 + pics/icons/view_index.svg | 1 + pics/icons/view_mag.svg | 1 + pics/icons/view_profile.svg | 1 + pics/icons/window_fullscreen.svg | 1 + pics/startuplogo.png | Bin 0 -> 23667 bytes pics/startuplogo_christmas.png | Bin 0 -> 97785 bytes pics/startuplogo_easter.jpg | Bin 0 -> 19182 bytes .../bookshelfmodel/btbookshelffiltermodel.cpp | 100 + .../bookshelfmodel/btbookshelffiltermodel.h | 60 + .../bookshelfmodel/btbookshelfmodel.cpp | 217 + src/backend/bookshelfmodel/btbookshelfmodel.h | 188 + .../bookshelfmodel/btbookshelftreemodel.cpp | 768 +++ .../bookshelfmodel/btbookshelftreemodel.h | 223 + src/backend/bookshelfmodel/categoryitem.cpp | 43 + src/backend/bookshelfmodel/categoryitem.h | 46 + src/backend/bookshelfmodel/indexingitem.cpp | 30 + src/backend/bookshelfmodel/indexingitem.h | 42 + src/backend/bookshelfmodel/item.cpp | 76 + src/backend/bookshelfmodel/item.h | 169 + src/backend/bookshelfmodel/languageitem.cpp | 36 + src/backend/bookshelfmodel/languageitem.h | 45 + src/backend/bookshelfmodel/moduleitem.cpp | 25 + src/backend/bookshelfmodel/moduleitem.h | 53 + src/backend/btbookmarksmodel.cpp | 945 +++ src/backend/btbookmarksmodel.h | 164 + src/backend/btglobal.cpp | 60 + src/backend/btglobal.h | 80 + src/backend/btinstallbackend.cpp | 196 + src/backend/btinstallbackend.h | 48 + src/backend/btinstallmgr.cpp | 128 + src/backend/btinstallmgr.h | 78 + src/backend/btinstallthread.cpp | 149 + src/backend/btinstallthread.h | 89 + src/backend/btsignal.cpp | 17 + src/backend/btsignal.h | 47 + src/backend/btsourcesthread.cpp | 81 + src/backend/btsourcesthread.h | 58 + src/backend/config/btconfig.cpp | 530 ++ src/backend/config/btconfig.h | 307 + src/backend/config/btconfigcore.cpp | 70 + src/backend/config/btconfigcore.h | 121 + src/backend/cswordmodulesearch.cpp | 358 ++ src/backend/cswordmodulesearch.h | 78 + src/backend/drivers/btconstmoduleset.h | 33 + src/backend/drivers/btmodulelist.h | 21 + src/backend/drivers/btmoduleset.h | 35 + src/backend/drivers/cswordbiblemoduleinfo.cpp | 154 + src/backend/drivers/cswordbiblemoduleinfo.h | 126 + src/backend/drivers/cswordbookmoduleinfo.cpp | 71 + src/backend/drivers/cswordbookmoduleinfo.h | 55 + .../drivers/cswordcommentarymoduleinfo.cpp | 41 + .../drivers/cswordcommentarymoduleinfo.h | 35 + .../drivers/cswordlexiconmoduleinfo.cpp | 232 + src/backend/drivers/cswordlexiconmoduleinfo.h | 71 + src/backend/drivers/cswordmoduleinfo.cpp | 1143 ++++ src/backend/drivers/cswordmoduleinfo.h | 438 ++ src/backend/filters/gbftohtml.cpp | 350 ++ src/backend/filters/gbftohtml.h | 79 + src/backend/filters/osistohtml.cpp | 611 ++ src/backend/filters/osistohtml.h | 86 + src/backend/filters/plaintohtml.cpp | 105 + src/backend/filters/plaintohtml.h | 44 + src/backend/filters/teitohtml.cpp | 207 + src/backend/filters/teitohtml.h | 52 + src/backend/filters/thmltohtml.cpp | 426 ++ src/backend/filters/thmltohtml.h | 75 + src/backend/keys/cswordkey.cpp | 125 + src/backend/keys/cswordkey.h | 115 + src/backend/keys/cswordldkey.cpp | 141 + src/backend/keys/cswordldkey.h | 104 + src/backend/keys/cswordtreekey.cpp | 113 + src/backend/keys/cswordtreekey.h | 114 + src/backend/keys/cswordversekey.cpp | 395 ++ src/backend/keys/cswordversekey.h | 201 + src/backend/language.cpp | 400 ++ src/backend/language.h | 56 + src/backend/managers/btlocalemgr.cpp | 63 + src/backend/managers/btlocalemgr.h | 33 + src/backend/managers/cdisplaytemplatemgr.cpp | 278 + src/backend/managers/cdisplaytemplatemgr.h | 110 + src/backend/managers/colormanager.cpp | 176 + src/backend/managers/colormanager.h | 29 + src/backend/managers/cswordbackend.cpp | 488 ++ src/backend/managers/cswordbackend.h | 245 + src/backend/managers/referencemanager.cpp | 243 + src/backend/managers/referencemanager.h | 75 + src/backend/models/btmoduletextmodel.cpp | 627 ++ src/backend/models/btmoduletextmodel.h | 194 + src/backend/rendering/btinforendering.cpp | 473 ++ src/backend/rendering/btinforendering.h | 46 + src/backend/rendering/cdisplayrendering.cpp | 271 + src/backend/rendering/cdisplayrendering.h | 65 + .../rendering/cplaintextexportrendering.cpp | 61 + .../rendering/cplaintextexportrendering.h | 45 + src/backend/rendering/crossrefrendering.cpp | 85 + src/backend/rendering/crossrefrendering.h | 41 + src/backend/rendering/ctextrendering.cpp | 479 ++ src/backend/rendering/ctextrendering.h | 174 + src/display-templates/Basic.tmpl | 34 + src/display-templates/Blue.cmap | 11 + src/display-templates/Blue.css | 334 ++ src/display-templates/Christmastide.cmap | 12 + src/display-templates/Christmastide.css | 152 + src/display-templates/Crazy.cmap | 11 + src/display-templates/Crazy.css | 318 + src/display-templates/Green.cmap | 11 + src/display-templates/Green.css | 302 + src/display-templates/HighContrast.cmap | 15 + src/display-templates/HighContrast.css | 320 + src/display-templates/README.txt | 63 + src/display-templates/Simple.cmap | 9 + src/display-templates/Simple.css | 134 + src/display-templates/basic_template.txt | 180 + src/frontend/BookmarkItem.h | 48 + src/frontend/BtMimeData.cpp | 20 + src/frontend/BtMimeData.h | 51 + src/frontend/bibletime.cpp | 372 ++ src/frontend/bibletime.h | 508 ++ src/frontend/bibletime_init.cpp | 898 +++ src/frontend/bibletime_slots.cpp | 742 +++ src/frontend/bibletimeapp.cpp | 317 + src/frontend/bibletimeapp.h | 59 + .../bookmarks/bteditbookmarkdialog.cpp | 82 + src/frontend/bookmarks/bteditbookmarkdialog.h | 65 + src/frontend/bookmarks/cbookmarkindex.cpp | 668 +++ src/frontend/bookmarks/cbookmarkindex.h | 111 + .../btbookshelfinstallfinalpage.cpp | 200 + .../btbookshelfinstallfinalpage.h | 76 + .../btbookshelflanguagespage.cpp | 136 + .../btbookshelflanguagespage.h | 57 + .../btbookshelfremovefinalpage.cpp | 64 + .../btbookshelfremovefinalpage.h | 46 + .../btbookshelfsourcespage.cpp | 210 + .../bookshelfwizard/btbookshelfsourcespage.h | 57 + .../btbookshelfsourcesprogresspage.cpp | 132 + .../btbookshelfsourcesprogresspage.h | 61 + .../bookshelfwizard/btbookshelftaskpage.cpp | 129 + .../bookshelfwizard/btbookshelftaskpage.h | 53 + .../bookshelfwizard/btbookshelfwizard.cpp | 185 + .../bookshelfwizard/btbookshelfwizard.h | 87 + .../bookshelfwizard/btbookshelfwizardenums.h | 31 + .../bookshelfwizard/btbookshelfwizardpage.cpp | 29 + .../bookshelfwizard/btbookshelfwizardpage.h | 34 + .../bookshelfwizard/btbookshelfworkspage.cpp | 364 ++ .../bookshelfwizard/btbookshelfworkspage.h | 87 + .../bookshelfwizard/btinstallpagemodel.cpp | 86 + .../bookshelfwizard/btinstallpagemodel.h | 41 + .../cswordsetupinstallsourcesdialog.cpp | 255 + .../cswordsetupinstallsourcesdialog.h | 41 + src/frontend/btaboutdialog.cpp | 352 ++ src/frontend/btaboutdialog.h | 57 + src/frontend/btaboutmoduledialog.cpp | 52 + src/frontend/btaboutmoduledialog.h | 50 + src/frontend/btbookshelfdockwidget.cpp | 218 + src/frontend/btbookshelfdockwidget.h | 77 + src/frontend/btbookshelfgroupingmenu.cpp | 115 + src/frontend/btbookshelfgroupingmenu.h | 54 + src/frontend/btbookshelfview.cpp | 111 + src/frontend/btbookshelfview.h | 46 + src/frontend/btbookshelfwidget.cpp | 253 + src/frontend/btbookshelfwidget.h | 121 + src/frontend/btcopybyreferencesdialog.cpp | 150 + src/frontend/btcopybyreferencesdialog.h | 70 + src/frontend/btmenuview.cpp | 245 + src/frontend/btmenuview.h | 132 + src/frontend/btmessageinputdialog.cpp | 96 + src/frontend/btmessageinputdialog.h | 68 + src/frontend/btmodulechooserdialog.cpp | 59 + src/frontend/btmodulechooserdialog.h | 46 + src/frontend/btmoduleindexdialog.cpp | 115 + src/frontend/btmoduleindexdialog.h | 61 + src/frontend/btopenworkaction.cpp | 123 + src/frontend/btopenworkaction.h | 84 + src/frontend/btprinter.cpp | 112 + src/frontend/btprinter.h | 38 + src/frontend/bttextbrowser.cpp | 85 + src/frontend/bttextbrowser.h | 44 + src/frontend/cexportmanager.cpp | 449 ++ src/frontend/cexportmanager.h | 131 + src/frontend/cinfodisplay.cpp | 167 + src/frontend/cinfodisplay.h | 58 + src/frontend/cmdiarea.cpp | 451 ++ src/frontend/cmdiarea.h | 170 + src/frontend/debugwindow.cpp | 116 + src/frontend/debugwindow.h | 42 + src/frontend/display/btcolorwidget.cpp | 52 + src/frontend/display/btcolorwidget.h | 48 + src/frontend/display/btfindwidget.cpp | 132 + src/frontend/display/btfindwidget.h | 81 + src/frontend/display/btfontsizewidget.cpp | 50 + src/frontend/display/btfontsizewidget.h | 46 + .../display/btmodelviewreaddisplay.cpp | 393 ++ src/frontend/display/btmodelviewreaddisplay.h | 200 + src/frontend/display/modelview/ColumnItem.qml | 108 + .../display/modelview/DisplayDelegate.qml | 238 + .../display/modelview/DisplayView.qml | 390 ++ .../display/modelview/btqmlinterface.cpp | 510 ++ .../display/modelview/btqmlinterface.h | 201 + .../display/modelview/btquickwidget.cpp | 173 + .../display/modelview/btquickwidget.h | 73 + .../display/modelview/modelviewqml.qrc | 7 + .../displaywindow/btactioncollection.cpp | 61 + .../displaywindow/btactioncollection.h | 75 + .../displaywindow/btdisplaysettingsbutton.cpp | 245 + .../displaywindow/btdisplaysettingsbutton.h | 78 + .../displaywindow/btmodulechooserbar.cpp | 113 + .../displaywindow/btmodulechooserbar.h | 65 + .../displaywindow/btmodulechooserbutton.cpp | 74 + .../displaywindow/btmodulechooserbutton.h | 68 + .../displaywindow/btmodulechoosermenu.cpp | 119 + .../displaywindow/btmodulechoosermenu.h | 87 + .../displaywindow/bttextwindowheader.cpp | 85 + .../displaywindow/bttextwindowheader.h | 66 + .../bttextwindowheaderwidget.cpp | 127 + .../displaywindow/bttextwindowheaderwidget.h | 75 + .../displaywindow/bttoolbarpopupaction.cpp | 70 + .../displaywindow/bttoolbarpopupaction.h | 48 + .../displaywindow/cbiblereadwindow.cpp | 374 ++ src/frontend/displaywindow/cbiblereadwindow.h | 133 + .../displaywindow/cbookreadwindow.cpp | 169 + src/frontend/displaywindow/cbookreadwindow.h | 71 + .../displaywindow/ccommentaryreadwindow.cpp | 183 + .../displaywindow/ccommentaryreadwindow.h | 68 + src/frontend/displaywindow/cdisplaywindow.cpp | 876 +++ src/frontend/displaywindow/cdisplaywindow.h | 307 + .../displaywindow/clexiconreadwindow.cpp | 64 + .../displaywindow/clexiconreadwindow.h | 64 + .../edittextwizard/btedittextpage.cpp | 345 ++ src/frontend/edittextwizard/btedittextpage.h | 84 + .../edittextwizard/btedittextwizard.cpp | 70 + .../edittextwizard/btedittextwizard.h | 53 + .../edittextwizard/btplainorhtmlpage.cpp | 61 + .../edittextwizard/btplainorhtmlpage.h | 44 + src/frontend/keychooser/bthistory.cpp | 108 + src/frontend/keychooser/bthistory.h | 75 + src/frontend/keychooser/btlocationedit.cpp | 49 + src/frontend/keychooser/btlocationedit.h | 29 + src/frontend/keychooser/cbookkeychooser.cpp | 263 + src/frontend/keychooser/cbookkeychooser.h | 82 + src/frontend/keychooser/cbooktreechooser.cpp | 184 + src/frontend/keychooser/cbooktreechooser.h | 72 + src/frontend/keychooser/ckeychooser.cpp | 60 + src/frontend/keychooser/ckeychooser.h | 90 + src/frontend/keychooser/ckeychooserwidget.cpp | 277 + src/frontend/keychooser/ckeychooserwidget.h | 149 + .../keychooser/clexiconkeychooser.cpp | 169 + src/frontend/keychooser/clexiconkeychooser.h | 61 + src/frontend/keychooser/cscrollbutton.cpp | 72 + src/frontend/keychooser/cscrollbutton.h | 85 + .../keychooser/cscrollerwidgetset.cpp | 90 + src/frontend/keychooser/cscrollerwidgetset.h | 69 + .../versekeychooser/btbiblekeywidget.cpp | 316 + .../versekeychooser/btbiblekeywidget.h | 68 + .../btdropdownchooserbutton.cpp | 63 + .../versekeychooser/btdropdownchooserbutton.h | 45 + .../versekeychooser/btversekeymenu.cpp | 52 + .../versekeychooser/btversekeymenu.h | 43 + .../versekeychooser/cbiblekeychooser.cpp | 98 + .../versekeychooser/cbiblekeychooser.h | 56 + src/frontend/main.cpp | 241 + src/frontend/messagedialog.cpp | 98 + src/frontend/messagedialog.h | 50 + .../analysis/csearchanalysisdialog.cpp | 85 + .../analysis/csearchanalysisdialog.h | 54 + .../analysis/csearchanalysisitem.cpp | 106 + .../analysis/csearchanalysisitem.h | 53 + .../analysis/csearchanalysislegenditem.cpp | 71 + .../analysis/csearchanalysislegenditem.h | 40 + .../analysis/csearchanalysisscene.cpp | 290 + .../analysis/csearchanalysisscene.h | 70 + .../analysis/csearchanalysisview.cpp | 38 + .../analysis/csearchanalysisview.h | 35 + src/frontend/searchdialog/btindexdialog.cpp | 199 + src/frontend/searchdialog/btindexdialog.h | 65 + .../btsearchmodulechooserdialog.cpp | 64 + .../btsearchmodulechooserdialog.h | 37 + .../searchdialog/btsearchoptionsarea.cpp | 430 ++ .../searchdialog/btsearchoptionsarea.h | 137 + .../searchdialog/btsearchresultarea.cpp | 279 + .../searchdialog/btsearchresultarea.h | 159 + .../searchdialog/btsearchsyntaxhelpdialog.cpp | 236 + .../searchdialog/btsearchsyntaxhelpdialog.h | 41 + .../searchdialog/chistorycombobox.cpp | 48 + src/frontend/searchdialog/chistorycombobox.h | 39 + .../searchdialog/cmoduleresultview.cpp | 341 ++ src/frontend/searchdialog/cmoduleresultview.h | 116 + .../searchdialog/crangechooserdialog.cpp | 299 + .../searchdialog/crangechooserdialog.h | 122 + src/frontend/searchdialog/csearchdialog.cpp | 237 + src/frontend/searchdialog/csearchdialog.h | 58 + .../searchdialog/csearchresultview.cpp | 238 + src/frontend/searchdialog/csearchresultview.h | 93 + .../settingsdialogs/btconfigdialog.cpp | 133 + src/frontend/settingsdialogs/btconfigdialog.h | 86 + .../settingsdialogs/btfontsettings.cpp | 161 + src/frontend/settingsdialogs/btfontsettings.h | 67 + .../settingsdialogs/btshortcutsdialog.cpp | 141 + .../settingsdialogs/btshortcutsdialog.h | 70 + .../settingsdialogs/btshortcutseditor.cpp | 380 ++ .../settingsdialogs/btshortcutseditor.h | 79 + .../settingsdialogs/btstandardworkstab.cpp | 190 + .../settingsdialogs/btstandardworkstab.h | 56 + .../settingsdialogs/bttextfilterstab.cpp | 91 + .../settingsdialogs/bttextfilterstab.h | 55 + .../bttexttospeechsettings.cpp | 150 + .../settingsdialogs/bttexttospeechsettings.h | 58 + .../settingsdialogs/cacceleratorsettings.cpp | 214 + .../settingsdialogs/cacceleratorsettings.h | 65 + .../settingsdialogs/cconfigurationdialog.cpp | 47 + .../settingsdialogs/cconfigurationdialog.h | 34 + .../settingsdialogs/cdisplaysettings.cpp | 370 ++ .../settingsdialogs/cdisplaysettings.h | 66 + .../settingsdialogs/cswordsettings.cpp | 52 + src/frontend/settingsdialogs/cswordsettings.h | 46 + src/frontend/tips/bttipdialog.cpp | 201 + src/frontend/tips/bttipdialog.h | 51 + src/frontend/welcome/btwelcomedialog.cpp | 89 + src/frontend/welcome/btwelcomedialog.h | 48 + src/util/btassert.h | 21 + src/util/btconnect.h | 28 + src/util/btdebugonly.h | 21 + src/util/bticons.cpp | 202 + src/util/bticons.h | 151 + src/util/btmodules.cpp | 33 + src/util/btmodules.h | 18 + src/util/cp1252.cpp | 40 + src/util/cp1252.h | 26 + src/util/cresmgr.cpp | 114 + src/util/cresmgr.h | 367 ++ src/util/directory.cpp | 326 + src/util/directory.h | 91 + src/util/tool.cpp | 126 + src/util/tool.h | 94 + 527 files changed, 274340 insertions(+) create mode 100644 CMakeLists.txt create mode 100644 CODE_OF_CONDUCT.md create mode 100644 FILE_HEADER.cpp.in create mode 100644 LICENSE create mode 100644 README.md create mode 100644 cmake/BTApplication.cmake create mode 100755 cmake/BTBinaryPackageWindows.cmake create mode 100644 cmake/BTDocumentation.cmake create mode 100644 cmake/BTWinIcon.rc create mode 100644 cmake/docs/docs.xsl.in create mode 100644 cmake/docs/pdf.xsl.in create mode 100755 cmake/fix_cpp_header.sh create mode 100644 cmake/platforms/linux/bibletime.desktop.cmake create mode 100644 cmake/platforms/linux/info.bibletime.BibleTime.metainfo.xml create mode 100644 cmake/sword_version_print.cpp create mode 100644 docs/.gitignore create mode 100644 docs/Doxyfile create mode 100644 docs/handbook/docbook/hdbk-config.docbook create mode 100644 docs/handbook/docbook/hdbk-intro.docbook create mode 100644 docs/handbook/docbook/hdbk-operation.docbook create mode 100644 docs/handbook/docbook/hdbk-reference.docbook create mode 100644 docs/handbook/docbook/hdbk-start.docbook create mode 100644 docs/handbook/docbook/index.docbook create mode 100644 docs/handbook/images/i_back.png create mode 100644 docs/handbook/images/i_bible.png create mode 100644 docs/handbook/images/i_bible_add.png create mode 100644 docs/handbook/images/i_bibletime.png create mode 100644 docs/handbook/images/i_book.png create mode 100644 docs/handbook/images/i_book_add.png create mode 100644 docs/handbook/images/i_bookmark.png create mode 100644 docs/handbook/images/i_books.png create mode 100644 docs/handbook/images/i_cascade.png create mode 100644 docs/handbook/images/i_checkbox.png create mode 100644 docs/handbook/images/i_commentary.png create mode 100644 docs/handbook/images/i_commentary_add.png create mode 100644 docs/handbook/images/i_configure.png create mode 100644 docs/handbook/images/i_configuresword.png create mode 100644 docs/handbook/images/i_contents2.png create mode 100644 docs/handbook/images/i_displayconfig.png create mode 100644 docs/handbook/images/i_document_magnifier.png create mode 100644 docs/handbook/images/i_exit.png create mode 100644 docs/handbook/images/i_fileclose.png create mode 100644 docs/handbook/images/i_find.png create mode 100644 docs/handbook/images/i_folder_open.png create mode 100644 docs/handbook/images/i_forward.png create mode 100644 docs/handbook/images/i_lexicon.png create mode 100644 docs/handbook/images/i_lexicon_add.png create mode 100644 docs/handbook/images/i_light_bulb.png create mode 100644 docs/handbook/images/i_sync.png create mode 100644 docs/handbook/images/i_tile.png create mode 100644 docs/handbook/images/i_tile_horiz.png create mode 100644 docs/handbook/images/i_tile_vert.png create mode 100644 docs/handbook/images/i_view_index.png create mode 100644 docs/handbook/images/i_view_mag.png create mode 100644 docs/handbook/images/i_window_fullscreen.png create mode 100644 docs/handbook/images/ss_configfonts.png create mode 100644 docs/handbook/images/ss_mainterms.png create mode 100644 docs/handbook/images/ss_searchanal.png create mode 100644 docs/handbook/images/ss_searchopts.png create mode 100644 docs/handbook/images/ss_shortcuts.png create mode 100644 docs/howto/docbook/howto-basics.docbook create mode 100644 docs/howto/docbook/howto-importance.docbook create mode 100644 docs/howto/docbook/howto-interpretation.docbook create mode 100644 docs/howto/docbook/index.docbook create mode 100644 i18n/handbook/handbook-ar.po create mode 100644 i18n/handbook/handbook-br.po create mode 100644 i18n/handbook/handbook-cs.po create mode 100644 i18n/handbook/handbook-de.po create mode 100644 i18n/handbook/handbook-es.po create mode 100644 i18n/handbook/handbook-fi.po create mode 100644 i18n/handbook/handbook-fr.po create mode 100644 i18n/handbook/handbook-hu.po create mode 100644 i18n/handbook/handbook-it.po create mode 100644 i18n/handbook/handbook-ko.po create mode 100644 i18n/handbook/handbook-lt.po create mode 100644 i18n/handbook/handbook-nl.po create mode 100644 i18n/handbook/handbook-pt_BR.po create mode 100644 i18n/handbook/handbook-ru.po create mode 100644 i18n/handbook/handbook-th.po create mode 100644 i18n/handbook/handbook-uk.po create mode 100644 i18n/handbook/handbook.pot create mode 100644 i18n/howto/howto-ar.po create mode 100644 i18n/howto/howto-bg.po create mode 100644 i18n/howto/howto-br.po create mode 100644 i18n/howto/howto-cs.po create mode 100644 i18n/howto/howto-da.po create mode 100644 i18n/howto/howto-de.po create mode 100644 i18n/howto/howto-es.po create mode 100644 i18n/howto/howto-fi.po create mode 100644 i18n/howto/howto-fr.po create mode 100644 i18n/howto/howto-hu.po create mode 100644 i18n/howto/howto-it.po create mode 100644 i18n/howto/howto-ja.po create mode 100644 i18n/howto/howto-ko.po create mode 100644 i18n/howto/howto-lt.po create mode 100644 i18n/howto/howto-nl.po create mode 100644 i18n/howto/howto-pt_BR.po create mode 100644 i18n/howto/howto-ru.po create mode 100644 i18n/howto/howto-th.po create mode 100644 i18n/howto/howto-uk.po create mode 100644 i18n/howto/howto.pot create mode 100644 i18n/messages/bibletime_translate.qrc create mode 100644 i18n/messages/bibletime_ui.ts create mode 100644 i18n/messages/bibletime_ui_ar.ts create mode 100644 i18n/messages/bibletime_ui_br.ts create mode 100644 i18n/messages/bibletime_ui_cs.ts create mode 100644 i18n/messages/bibletime_ui_da.ts create mode 100644 i18n/messages/bibletime_ui_de.ts create mode 100644 i18n/messages/bibletime_ui_en_GB.ts create mode 100644 i18n/messages/bibletime_ui_es.ts create mode 100644 i18n/messages/bibletime_ui_et.ts create mode 100644 i18n/messages/bibletime_ui_fi.ts create mode 100644 i18n/messages/bibletime_ui_fr.ts create mode 100644 i18n/messages/bibletime_ui_hu.ts create mode 100644 i18n/messages/bibletime_ui_it.ts create mode 100644 i18n/messages/bibletime_ui_ja.ts create mode 100644 i18n/messages/bibletime_ui_ko.ts create mode 100644 i18n/messages/bibletime_ui_lt.ts create mode 100644 i18n/messages/bibletime_ui_lv.ts create mode 100644 i18n/messages/bibletime_ui_nl.ts create mode 100644 i18n/messages/bibletime_ui_pl.ts create mode 100644 i18n/messages/bibletime_ui_pt.ts create mode 100644 i18n/messages/bibletime_ui_pt_BR.ts create mode 100644 i18n/messages/bibletime_ui_ru.ts create mode 100644 i18n/messages/bibletime_ui_sk.ts create mode 100644 i18n/messages/bibletime_ui_th.ts create mode 100644 i18n/messages/bibletime_ui_uk.ts create mode 100644 i18n/messages/bibletime_ui_zh_TW.ts create mode 100644 i18n/messages/test_translate.qrc create mode 100644 pics/icons/LICENSE create mode 100644 pics/icons/add.svg create mode 100644 pics/icons/automatically.svg create mode 100644 pics/icons/back.svg create mode 100644 pics/icons/bible.svg create mode 100644 pics/icons/bibletime.ico create mode 100644 pics/icons/bibletime.png create mode 100644 pics/icons/bibletime.svg create mode 100644 pics/icons/book.svg create mode 100644 pics/icons/bookmark.svg create mode 100644 pics/icons/books.svg create mode 100644 pics/icons/calendar.svg create mode 100644 pics/icons/cascade.svg create mode 100644 pics/icons/checkbox.svg create mode 100644 pics/icons/commentary.svg create mode 100644 pics/icons/configure.svg create mode 100644 pics/icons/contents2.svg create mode 100644 pics/icons/delete.svg create mode 100644 pics/icons/dictionary.svg create mode 100644 pics/icons/displayconfig.svg create mode 100644 pics/icons/document_magnifier.svg create mode 100644 pics/icons/edit_clear_locationbar.svg create mode 100644 pics/icons/edit_copy.svg create mode 100644 pics/icons/exit.svg create mode 100644 pics/icons/export.svg create mode 100644 pics/icons/file_save.svg create mode 100644 pics/icons/fileclose.svg create mode 100644 pics/icons/find.svg create mode 100644 pics/icons/flag.svg create mode 100644 pics/icons/folder-open.svg create mode 100644 pics/icons/folder.svg create mode 100644 pics/icons/fonts.svg create mode 100644 pics/icons/forward.svg create mode 100644 pics/icons/import.svg create mode 100644 pics/icons/info.svg create mode 100644 pics/icons/key_bindings.svg create mode 100644 pics/icons/layer-visible-on.svg create mode 100644 pics/icons/lexicon.svg create mode 100644 pics/icons/light_bulb.svg create mode 100644 pics/icons/lock.svg create mode 100644 pics/icons/manual.svg create mode 100644 pics/icons/map.svg create mode 100644 pics/icons/plus.svg create mode 100644 pics/icons/pointing_arrow.svg create mode 100644 pics/icons/print.svg create mode 100644 pics/icons/questionable.svg create mode 100644 pics/icons/remove.svg create mode 100644 pics/icons/speaker.svg create mode 100644 pics/icons/startconfig.svg create mode 100644 pics/icons/stop.svg create mode 100644 pics/icons/swordconfig.svg create mode 100644 pics/icons/sync.svg create mode 100644 pics/icons/tabbed.svg create mode 100644 pics/icons/text_bold.svg create mode 100644 pics/icons/text_center.svg create mode 100644 pics/icons/text_italic.svg create mode 100644 pics/icons/text_leftalign.svg create mode 100644 pics/icons/text_rightalign.svg create mode 100644 pics/icons/text_under.svg create mode 100644 pics/icons/tile.svg create mode 100644 pics/icons/tile_horiz.svg create mode 100644 pics/icons/tile_vert.svg create mode 100644 pics/icons/trash.svg create mode 100644 pics/icons/unlock.svg create mode 100644 pics/icons/view-tree.svg create mode 100644 pics/icons/view_index.svg create mode 100644 pics/icons/view_mag.svg create mode 100644 pics/icons/view_profile.svg create mode 100644 pics/icons/window_fullscreen.svg create mode 100644 pics/startuplogo.png create mode 100644 pics/startuplogo_christmas.png create mode 100644 pics/startuplogo_easter.jpg create mode 100644 src/backend/bookshelfmodel/btbookshelffiltermodel.cpp create mode 100644 src/backend/bookshelfmodel/btbookshelffiltermodel.h create mode 100644 src/backend/bookshelfmodel/btbookshelfmodel.cpp create mode 100644 src/backend/bookshelfmodel/btbookshelfmodel.h create mode 100644 src/backend/bookshelfmodel/btbookshelftreemodel.cpp create mode 100644 src/backend/bookshelfmodel/btbookshelftreemodel.h create mode 100644 src/backend/bookshelfmodel/categoryitem.cpp create mode 100644 src/backend/bookshelfmodel/categoryitem.h create mode 100644 src/backend/bookshelfmodel/indexingitem.cpp create mode 100644 src/backend/bookshelfmodel/indexingitem.h create mode 100644 src/backend/bookshelfmodel/item.cpp create mode 100644 src/backend/bookshelfmodel/item.h create mode 100644 src/backend/bookshelfmodel/languageitem.cpp create mode 100644 src/backend/bookshelfmodel/languageitem.h create mode 100644 src/backend/bookshelfmodel/moduleitem.cpp create mode 100644 src/backend/bookshelfmodel/moduleitem.h create mode 100644 src/backend/btbookmarksmodel.cpp create mode 100644 src/backend/btbookmarksmodel.h create mode 100644 src/backend/btglobal.cpp create mode 100644 src/backend/btglobal.h create mode 100644 src/backend/btinstallbackend.cpp create mode 100644 src/backend/btinstallbackend.h create mode 100644 src/backend/btinstallmgr.cpp create mode 100644 src/backend/btinstallmgr.h create mode 100644 src/backend/btinstallthread.cpp create mode 100644 src/backend/btinstallthread.h create mode 100644 src/backend/btsignal.cpp create mode 100644 src/backend/btsignal.h create mode 100644 src/backend/btsourcesthread.cpp create mode 100644 src/backend/btsourcesthread.h create mode 100644 src/backend/config/btconfig.cpp create mode 100644 src/backend/config/btconfig.h create mode 100644 src/backend/config/btconfigcore.cpp create mode 100644 src/backend/config/btconfigcore.h create mode 100644 src/backend/cswordmodulesearch.cpp create mode 100644 src/backend/cswordmodulesearch.h create mode 100644 src/backend/drivers/btconstmoduleset.h create mode 100644 src/backend/drivers/btmodulelist.h create mode 100644 src/backend/drivers/btmoduleset.h create mode 100644 src/backend/drivers/cswordbiblemoduleinfo.cpp create mode 100644 src/backend/drivers/cswordbiblemoduleinfo.h create mode 100644 src/backend/drivers/cswordbookmoduleinfo.cpp create mode 100644 src/backend/drivers/cswordbookmoduleinfo.h create mode 100644 src/backend/drivers/cswordcommentarymoduleinfo.cpp create mode 100644 src/backend/drivers/cswordcommentarymoduleinfo.h create mode 100644 src/backend/drivers/cswordlexiconmoduleinfo.cpp create mode 100644 src/backend/drivers/cswordlexiconmoduleinfo.h create mode 100644 src/backend/drivers/cswordmoduleinfo.cpp create mode 100644 src/backend/drivers/cswordmoduleinfo.h create mode 100644 src/backend/filters/gbftohtml.cpp create mode 100644 src/backend/filters/gbftohtml.h create mode 100644 src/backend/filters/osistohtml.cpp create mode 100644 src/backend/filters/osistohtml.h create mode 100644 src/backend/filters/plaintohtml.cpp create mode 100644 src/backend/filters/plaintohtml.h create mode 100644 src/backend/filters/teitohtml.cpp create mode 100644 src/backend/filters/teitohtml.h create mode 100644 src/backend/filters/thmltohtml.cpp create mode 100644 src/backend/filters/thmltohtml.h create mode 100644 src/backend/keys/cswordkey.cpp create mode 100644 src/backend/keys/cswordkey.h create mode 100644 src/backend/keys/cswordldkey.cpp create mode 100644 src/backend/keys/cswordldkey.h create mode 100644 src/backend/keys/cswordtreekey.cpp create mode 100644 src/backend/keys/cswordtreekey.h create mode 100644 src/backend/keys/cswordversekey.cpp create mode 100644 src/backend/keys/cswordversekey.h create mode 100644 src/backend/language.cpp create mode 100644 src/backend/language.h create mode 100644 src/backend/managers/btlocalemgr.cpp create mode 100644 src/backend/managers/btlocalemgr.h create mode 100644 src/backend/managers/cdisplaytemplatemgr.cpp create mode 100644 src/backend/managers/cdisplaytemplatemgr.h create mode 100644 src/backend/managers/colormanager.cpp create mode 100644 src/backend/managers/colormanager.h create mode 100644 src/backend/managers/cswordbackend.cpp create mode 100644 src/backend/managers/cswordbackend.h create mode 100644 src/backend/managers/referencemanager.cpp create mode 100644 src/backend/managers/referencemanager.h create mode 100644 src/backend/models/btmoduletextmodel.cpp create mode 100644 src/backend/models/btmoduletextmodel.h create mode 100644 src/backend/rendering/btinforendering.cpp create mode 100644 src/backend/rendering/btinforendering.h create mode 100644 src/backend/rendering/cdisplayrendering.cpp create mode 100644 src/backend/rendering/cdisplayrendering.h create mode 100644 src/backend/rendering/cplaintextexportrendering.cpp create mode 100644 src/backend/rendering/cplaintextexportrendering.h create mode 100644 src/backend/rendering/crossrefrendering.cpp create mode 100644 src/backend/rendering/crossrefrendering.h create mode 100644 src/backend/rendering/ctextrendering.cpp create mode 100644 src/backend/rendering/ctextrendering.h create mode 100644 src/display-templates/Basic.tmpl create mode 100644 src/display-templates/Blue.cmap create mode 100644 src/display-templates/Blue.css create mode 100644 src/display-templates/Christmastide.cmap create mode 100644 src/display-templates/Christmastide.css create mode 100644 src/display-templates/Crazy.cmap create mode 100644 src/display-templates/Crazy.css create mode 100644 src/display-templates/Green.cmap create mode 100644 src/display-templates/Green.css create mode 100644 src/display-templates/HighContrast.cmap create mode 100644 src/display-templates/HighContrast.css create mode 100644 src/display-templates/README.txt create mode 100644 src/display-templates/Simple.cmap create mode 100644 src/display-templates/Simple.css create mode 100644 src/display-templates/basic_template.txt create mode 100644 src/frontend/BookmarkItem.h create mode 100644 src/frontend/BtMimeData.cpp create mode 100644 src/frontend/BtMimeData.h create mode 100644 src/frontend/bibletime.cpp create mode 100644 src/frontend/bibletime.h create mode 100644 src/frontend/bibletime_init.cpp create mode 100644 src/frontend/bibletime_slots.cpp create mode 100644 src/frontend/bibletimeapp.cpp create mode 100644 src/frontend/bibletimeapp.h create mode 100644 src/frontend/bookmarks/bteditbookmarkdialog.cpp create mode 100644 src/frontend/bookmarks/bteditbookmarkdialog.h create mode 100644 src/frontend/bookmarks/cbookmarkindex.cpp create mode 100644 src/frontend/bookmarks/cbookmarkindex.h create mode 100644 src/frontend/bookshelfwizard/btbookshelfinstallfinalpage.cpp create mode 100644 src/frontend/bookshelfwizard/btbookshelfinstallfinalpage.h create mode 100644 src/frontend/bookshelfwizard/btbookshelflanguagespage.cpp create mode 100644 src/frontend/bookshelfwizard/btbookshelflanguagespage.h create mode 100644 src/frontend/bookshelfwizard/btbookshelfremovefinalpage.cpp create mode 100644 src/frontend/bookshelfwizard/btbookshelfremovefinalpage.h create mode 100644 src/frontend/bookshelfwizard/btbookshelfsourcespage.cpp create mode 100644 src/frontend/bookshelfwizard/btbookshelfsourcespage.h create mode 100644 src/frontend/bookshelfwizard/btbookshelfsourcesprogresspage.cpp create mode 100644 src/frontend/bookshelfwizard/btbookshelfsourcesprogresspage.h create mode 100644 src/frontend/bookshelfwizard/btbookshelftaskpage.cpp create mode 100644 src/frontend/bookshelfwizard/btbookshelftaskpage.h create mode 100644 src/frontend/bookshelfwizard/btbookshelfwizard.cpp create mode 100644 src/frontend/bookshelfwizard/btbookshelfwizard.h create mode 100644 src/frontend/bookshelfwizard/btbookshelfwizardenums.h create mode 100644 src/frontend/bookshelfwizard/btbookshelfwizardpage.cpp create mode 100644 src/frontend/bookshelfwizard/btbookshelfwizardpage.h create mode 100644 src/frontend/bookshelfwizard/btbookshelfworkspage.cpp create mode 100644 src/frontend/bookshelfwizard/btbookshelfworkspage.h create mode 100644 src/frontend/bookshelfwizard/btinstallpagemodel.cpp create mode 100644 src/frontend/bookshelfwizard/btinstallpagemodel.h create mode 100644 src/frontend/bookshelfwizard/cswordsetupinstallsourcesdialog.cpp create mode 100644 src/frontend/bookshelfwizard/cswordsetupinstallsourcesdialog.h create mode 100644 src/frontend/btaboutdialog.cpp create mode 100644 src/frontend/btaboutdialog.h create mode 100644 src/frontend/btaboutmoduledialog.cpp create mode 100644 src/frontend/btaboutmoduledialog.h create mode 100644 src/frontend/btbookshelfdockwidget.cpp create mode 100644 src/frontend/btbookshelfdockwidget.h create mode 100644 src/frontend/btbookshelfgroupingmenu.cpp create mode 100644 src/frontend/btbookshelfgroupingmenu.h create mode 100644 src/frontend/btbookshelfview.cpp create mode 100644 src/frontend/btbookshelfview.h create mode 100644 src/frontend/btbookshelfwidget.cpp create mode 100644 src/frontend/btbookshelfwidget.h create mode 100644 src/frontend/btcopybyreferencesdialog.cpp create mode 100644 src/frontend/btcopybyreferencesdialog.h create mode 100644 src/frontend/btmenuview.cpp create mode 100644 src/frontend/btmenuview.h create mode 100644 src/frontend/btmessageinputdialog.cpp create mode 100644 src/frontend/btmessageinputdialog.h create mode 100644 src/frontend/btmodulechooserdialog.cpp create mode 100644 src/frontend/btmodulechooserdialog.h create mode 100644 src/frontend/btmoduleindexdialog.cpp create mode 100644 src/frontend/btmoduleindexdialog.h create mode 100644 src/frontend/btopenworkaction.cpp create mode 100644 src/frontend/btopenworkaction.h create mode 100644 src/frontend/btprinter.cpp create mode 100644 src/frontend/btprinter.h create mode 100644 src/frontend/bttextbrowser.cpp create mode 100644 src/frontend/bttextbrowser.h create mode 100644 src/frontend/cexportmanager.cpp create mode 100644 src/frontend/cexportmanager.h create mode 100644 src/frontend/cinfodisplay.cpp create mode 100644 src/frontend/cinfodisplay.h create mode 100644 src/frontend/cmdiarea.cpp create mode 100644 src/frontend/cmdiarea.h create mode 100644 src/frontend/debugwindow.cpp create mode 100644 src/frontend/debugwindow.h create mode 100644 src/frontend/display/btcolorwidget.cpp create mode 100644 src/frontend/display/btcolorwidget.h create mode 100644 src/frontend/display/btfindwidget.cpp create mode 100644 src/frontend/display/btfindwidget.h create mode 100644 src/frontend/display/btfontsizewidget.cpp create mode 100644 src/frontend/display/btfontsizewidget.h create mode 100644 src/frontend/display/btmodelviewreaddisplay.cpp create mode 100644 src/frontend/display/btmodelviewreaddisplay.h create mode 100644 src/frontend/display/modelview/ColumnItem.qml create mode 100644 src/frontend/display/modelview/DisplayDelegate.qml create mode 100644 src/frontend/display/modelview/DisplayView.qml create mode 100644 src/frontend/display/modelview/btqmlinterface.cpp create mode 100644 src/frontend/display/modelview/btqmlinterface.h create mode 100644 src/frontend/display/modelview/btquickwidget.cpp create mode 100644 src/frontend/display/modelview/btquickwidget.h create mode 100644 src/frontend/display/modelview/modelviewqml.qrc create mode 100644 src/frontend/displaywindow/btactioncollection.cpp create mode 100644 src/frontend/displaywindow/btactioncollection.h create mode 100644 src/frontend/displaywindow/btdisplaysettingsbutton.cpp create mode 100644 src/frontend/displaywindow/btdisplaysettingsbutton.h create mode 100644 src/frontend/displaywindow/btmodulechooserbar.cpp create mode 100644 src/frontend/displaywindow/btmodulechooserbar.h create mode 100644 src/frontend/displaywindow/btmodulechooserbutton.cpp create mode 100644 src/frontend/displaywindow/btmodulechooserbutton.h create mode 100644 src/frontend/displaywindow/btmodulechoosermenu.cpp create mode 100644 src/frontend/displaywindow/btmodulechoosermenu.h create mode 100644 src/frontend/displaywindow/bttextwindowheader.cpp create mode 100644 src/frontend/displaywindow/bttextwindowheader.h create mode 100644 src/frontend/displaywindow/bttextwindowheaderwidget.cpp create mode 100644 src/frontend/displaywindow/bttextwindowheaderwidget.h create mode 100644 src/frontend/displaywindow/bttoolbarpopupaction.cpp create mode 100644 src/frontend/displaywindow/bttoolbarpopupaction.h create mode 100644 src/frontend/displaywindow/cbiblereadwindow.cpp create mode 100644 src/frontend/displaywindow/cbiblereadwindow.h create mode 100644 src/frontend/displaywindow/cbookreadwindow.cpp create mode 100644 src/frontend/displaywindow/cbookreadwindow.h create mode 100644 src/frontend/displaywindow/ccommentaryreadwindow.cpp create mode 100644 src/frontend/displaywindow/ccommentaryreadwindow.h create mode 100644 src/frontend/displaywindow/cdisplaywindow.cpp create mode 100644 src/frontend/displaywindow/cdisplaywindow.h create mode 100644 src/frontend/displaywindow/clexiconreadwindow.cpp create mode 100644 src/frontend/displaywindow/clexiconreadwindow.h create mode 100644 src/frontend/edittextwizard/btedittextpage.cpp create mode 100644 src/frontend/edittextwizard/btedittextpage.h create mode 100644 src/frontend/edittextwizard/btedittextwizard.cpp create mode 100644 src/frontend/edittextwizard/btedittextwizard.h create mode 100644 src/frontend/edittextwizard/btplainorhtmlpage.cpp create mode 100644 src/frontend/edittextwizard/btplainorhtmlpage.h create mode 100644 src/frontend/keychooser/bthistory.cpp create mode 100644 src/frontend/keychooser/bthistory.h create mode 100644 src/frontend/keychooser/btlocationedit.cpp create mode 100644 src/frontend/keychooser/btlocationedit.h create mode 100644 src/frontend/keychooser/cbookkeychooser.cpp create mode 100644 src/frontend/keychooser/cbookkeychooser.h create mode 100644 src/frontend/keychooser/cbooktreechooser.cpp create mode 100644 src/frontend/keychooser/cbooktreechooser.h create mode 100644 src/frontend/keychooser/ckeychooser.cpp create mode 100644 src/frontend/keychooser/ckeychooser.h create mode 100644 src/frontend/keychooser/ckeychooserwidget.cpp create mode 100644 src/frontend/keychooser/ckeychooserwidget.h create mode 100644 src/frontend/keychooser/clexiconkeychooser.cpp create mode 100644 src/frontend/keychooser/clexiconkeychooser.h create mode 100644 src/frontend/keychooser/cscrollbutton.cpp create mode 100644 src/frontend/keychooser/cscrollbutton.h create mode 100644 src/frontend/keychooser/cscrollerwidgetset.cpp create mode 100644 src/frontend/keychooser/cscrollerwidgetset.h create mode 100644 src/frontend/keychooser/versekeychooser/btbiblekeywidget.cpp create mode 100644 src/frontend/keychooser/versekeychooser/btbiblekeywidget.h create mode 100644 src/frontend/keychooser/versekeychooser/btdropdownchooserbutton.cpp create mode 100644 src/frontend/keychooser/versekeychooser/btdropdownchooserbutton.h create mode 100644 src/frontend/keychooser/versekeychooser/btversekeymenu.cpp create mode 100644 src/frontend/keychooser/versekeychooser/btversekeymenu.h create mode 100644 src/frontend/keychooser/versekeychooser/cbiblekeychooser.cpp create mode 100644 src/frontend/keychooser/versekeychooser/cbiblekeychooser.h create mode 100644 src/frontend/main.cpp create mode 100644 src/frontend/messagedialog.cpp create mode 100644 src/frontend/messagedialog.h create mode 100644 src/frontend/searchdialog/analysis/csearchanalysisdialog.cpp create mode 100644 src/frontend/searchdialog/analysis/csearchanalysisdialog.h create mode 100644 src/frontend/searchdialog/analysis/csearchanalysisitem.cpp create mode 100644 src/frontend/searchdialog/analysis/csearchanalysisitem.h create mode 100644 src/frontend/searchdialog/analysis/csearchanalysislegenditem.cpp create mode 100644 src/frontend/searchdialog/analysis/csearchanalysislegenditem.h create mode 100644 src/frontend/searchdialog/analysis/csearchanalysisscene.cpp create mode 100644 src/frontend/searchdialog/analysis/csearchanalysisscene.h create mode 100644 src/frontend/searchdialog/analysis/csearchanalysisview.cpp create mode 100644 src/frontend/searchdialog/analysis/csearchanalysisview.h create mode 100644 src/frontend/searchdialog/btindexdialog.cpp create mode 100644 src/frontend/searchdialog/btindexdialog.h create mode 100644 src/frontend/searchdialog/btsearchmodulechooserdialog.cpp create mode 100644 src/frontend/searchdialog/btsearchmodulechooserdialog.h create mode 100644 src/frontend/searchdialog/btsearchoptionsarea.cpp create mode 100644 src/frontend/searchdialog/btsearchoptionsarea.h create mode 100644 src/frontend/searchdialog/btsearchresultarea.cpp create mode 100644 src/frontend/searchdialog/btsearchresultarea.h create mode 100644 src/frontend/searchdialog/btsearchsyntaxhelpdialog.cpp create mode 100644 src/frontend/searchdialog/btsearchsyntaxhelpdialog.h create mode 100644 src/frontend/searchdialog/chistorycombobox.cpp create mode 100644 src/frontend/searchdialog/chistorycombobox.h create mode 100644 src/frontend/searchdialog/cmoduleresultview.cpp create mode 100644 src/frontend/searchdialog/cmoduleresultview.h create mode 100644 src/frontend/searchdialog/crangechooserdialog.cpp create mode 100644 src/frontend/searchdialog/crangechooserdialog.h create mode 100644 src/frontend/searchdialog/csearchdialog.cpp create mode 100644 src/frontend/searchdialog/csearchdialog.h create mode 100644 src/frontend/searchdialog/csearchresultview.cpp create mode 100644 src/frontend/searchdialog/csearchresultview.h create mode 100644 src/frontend/settingsdialogs/btconfigdialog.cpp create mode 100644 src/frontend/settingsdialogs/btconfigdialog.h create mode 100644 src/frontend/settingsdialogs/btfontsettings.cpp create mode 100644 src/frontend/settingsdialogs/btfontsettings.h create mode 100644 src/frontend/settingsdialogs/btshortcutsdialog.cpp create mode 100644 src/frontend/settingsdialogs/btshortcutsdialog.h create mode 100644 src/frontend/settingsdialogs/btshortcutseditor.cpp create mode 100644 src/frontend/settingsdialogs/btshortcutseditor.h create mode 100644 src/frontend/settingsdialogs/btstandardworkstab.cpp create mode 100644 src/frontend/settingsdialogs/btstandardworkstab.h create mode 100644 src/frontend/settingsdialogs/bttextfilterstab.cpp create mode 100644 src/frontend/settingsdialogs/bttextfilterstab.h create mode 100644 src/frontend/settingsdialogs/bttexttospeechsettings.cpp create mode 100644 src/frontend/settingsdialogs/bttexttospeechsettings.h create mode 100644 src/frontend/settingsdialogs/cacceleratorsettings.cpp create mode 100644 src/frontend/settingsdialogs/cacceleratorsettings.h create mode 100644 src/frontend/settingsdialogs/cconfigurationdialog.cpp create mode 100644 src/frontend/settingsdialogs/cconfigurationdialog.h create mode 100644 src/frontend/settingsdialogs/cdisplaysettings.cpp create mode 100644 src/frontend/settingsdialogs/cdisplaysettings.h create mode 100644 src/frontend/settingsdialogs/cswordsettings.cpp create mode 100644 src/frontend/settingsdialogs/cswordsettings.h create mode 100644 src/frontend/tips/bttipdialog.cpp create mode 100644 src/frontend/tips/bttipdialog.h create mode 100644 src/frontend/welcome/btwelcomedialog.cpp create mode 100644 src/frontend/welcome/btwelcomedialog.h create mode 100644 src/util/btassert.h create mode 100644 src/util/btconnect.h create mode 100644 src/util/btdebugonly.h create mode 100644 src/util/bticons.cpp create mode 100644 src/util/bticons.h create mode 100644 src/util/btmodules.cpp create mode 100644 src/util/btmodules.h create mode 100644 src/util/cp1252.cpp create mode 100644 src/util/cp1252.h create mode 100644 src/util/cresmgr.cpp create mode 100644 src/util/cresmgr.h create mode 100644 src/util/directory.cpp create mode 100644 src/util/directory.h create mode 100644 src/util/tool.cpp create mode 100644 src/util/tool.h diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..3de56d9 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,201 @@ +CMAKE_MINIMUM_REQUIRED(VERSION 3.25) +MESSAGE(STATUS "Using CMake ${CMAKE_VERSION}: ${CMAKE_COMMAND}") +PROJECT(BibleTime + VERSION 3.2.0 + DESCRIPTION "A Bible study application" + HOMEPAGE_URL "https://bibletime.info/" + LANGUAGES NONE # Defer compiler detection (logs) to AFTER versioning logic +) +SET(PROJECT_VERSION_TWEAK "") # e.g. _alpha1, _beta2, _rc3 +SET(PROJECT_VERSION "${PROJECT_VERSION}${PROJECT_VERSION_TWEAK}") +MESSAGE(STATUS "BibleTime version in CMakeLists.txt: ${PROJECT_VERSION}") +BLOCK(PROPAGATE PROJECT_VERSION) + IF(IS_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/.git") + FIND_PACKAGE(Git REQUIRED) + EXECUTE_PROCESS( + COMMAND ${GIT_EXECUTABLE} describe --match "v*.*.*" --dirty --abbrev=12 + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + OUTPUT_VARIABLE GIT_DESCRIBE + ENCODING "UTF-8" + OUTPUT_STRIP_TRAILING_WHITESPACE + COMMAND_ERROR_IS_FATAL ANY + ) + IF(NOT ("${GIT_DESCRIBE}" MATCHES "^v${PROJECT_VERSION}")) + MESSAGE(FATAL_ERROR "Project version doesn't match `git describe`!") + ENDIF() + STRING(SUBSTRING "${GIT_DESCRIBE}" 1 -1 PROJECT_VERSION) + ENDIF() +ENDBLOCK() +IF(PROJECT_IS_TOP_LEVEL) + SET(CMAKE_PROJECT_VERSION "${PROJECT_VERSION}") +ENDIF() +MESSAGE(STATUS "Configuring BibleTime version ${PROJECT_VERSION}") +ENABLE_LANGUAGE(CXX) # This logs compiler detection messages AFTER the above + + +###################################################### +# Retrieve and log more information about build environment: +# +BLOCK() + FOREACH(KEY IN ITEMS OS_NAME OS_RELEASE OS_VERSION OS_PLATFORM) + CMAKE_HOST_SYSTEM_INFORMATION(RESULT VALUE QUERY "${KEY}") + MESSAGE(STATUS "${KEY}: ${VALUE}") + ENDFOREACH() + CMAKE_HOST_SYSTEM_INFORMATION(RESULT OS_RELEASE_FILE QUERY DISTRIB_INFO) + IF("(${OS_RELEASE_FILE})" STREQUAL "()") + MESSAGE(STATUS "No /etc/os-release information found.") + ELSE() + MESSAGE(STATUS "Information from /etc/os-release:") + FOREACH(OS_RELEASE_KEY IN LISTS OS_RELEASE_FILE) + MESSAGE(STATUS " ${OS_RELEASE_KEY}: ${${OS_RELEASE_KEY}}") + ENDFOREACH() + ENDIF() +ENDBLOCK() + + +###################################################### +# Build-time user options: +# +SET(BUILD_BIBLETIME "ON" CACHE BOOL + "Whether to build and install the BibleTime application") + +SET(BUILD_TEXT_TO_SPEECH "ON" CACHE BOOL + "Whether to build BibleTime with text-to-speech (TTS) support. \ +This requires Qt's TextToSpeech module.") + +SET(BUILD_HANDBOOK_HTML "ON" CACHE BOOL + "Whether to build and install the handbook in HTML format") +SET(BUILD_HANDBOOK_HTML_LANGUAGES "" CACHE STRING + "A semicolon-separated list of language codes for which to build and +install the handbook in HTML format if BUILD_HANDBOOK_HTML is enabled. \ +Leave empty use all supported languages.") + +SET(BUILD_HANDBOOK_PDF "ON" CACHE BOOL + "Whether to build and install the handbook in PDF") +SET(BUILD_HANDBOOK_PDF_LANGUAGES "" CACHE STRING + "A semicolon-separated list of language codes for which to build and \ +install the handbook in PDF format if BUILD_HANDBOOK_PDF is enabled. \ +Leave empty use all supported languages.") + +SET(BUILD_HOWTO_HTML "ON" CACHE BOOL + "Whether to build and install the howto in HTML format") +SET(BUILD_HOWTO_HTML_LANGUAGES "" CACHE STRING + "A semicolon-separated list of language codes for which to build and \ +install the howto in HTML format if BUILD_HOWTO_HTML is enabled. \ +Leave empty use all supported languages.") + +SET(BUILD_HOWTO_PDF "ON" CACHE BOOL + "Whether to build and install the howto in PDF format") +SET(BUILD_HOWTO_PDF_LANGUAGES "" CACHE STRING + "A semicolon-separated list of language codes for which to build and \ +install the howto in PDF format if BUILD_HOWTO_PDF is enabled. \ +Leave empty use all supported languages.") + +SET(INSTALL_GENERATED_DOCS "OFF" CACHE BOOL + "Install generated_docs from a specified path.") +SET(GENERATED_DOCS_DIR "" CACHE PATH + "Path to the checked out generated_docs for this revision of BibleTime") + +###################################################### +# Misc. settings: +# +SET_PROPERTY(GLOBAL PROPERTY USE_FOLDERS ON) + + +###################################################### +# Load user configuration files: +# +# If BIBLETIME_BUILDCONFIG set, load the file and fail on error. Otherwise, try +# to include either "config.cmake" under either the build directory or the +# source directory, whichever file first exists, if at all. +IF(DEFINED BIBLETIME_BUILDCONFIG) + IF(BIBLETIME_BUILDCONFIG_IS_RELATIVE) + SET(BIBLETIME_BUILDCONFIG + "${CMAKE_CURRENT_BINARY_DIR}/${BIBLETIME_BUILDCONFIG}") + ENDIF() + INCLUDE("${BIBLETIME_BUILDCONFIG}" OPTIONAL RESULT_VARIABLE r) + IF(r) + MESSAGE(STATUS "Included \"${BIBLETIME_BUILDCONFIG}\"") + UNSET(r) + ELSE() + MESSAGE(FATAL_ERROR + "Failed to include build configuration from \"${BIBLETIME_BUILDCONFIG}\"!") + ENDIF() +ELSE() + INCLUDE("${CMAKE_CURRENT_BINARY_DIR}/config.cmake" OPTIONAL RESULT_VARIABLE r) + IF(r) + MESSAGE(STATUS "Included \"${r}\"") + ELSE() + INCLUDE("${CMAKE_CURRENT_SOURCE_DIR}/config.cmake" + OPTIONAL RESULT_VARIABLE r) + IF(r) + MESSAGE(STATUS "Included \"${r}\"") + ENDIF() + ENDIF() + UNSET(r) +ENDIF() + + +###################################################### +# Set CMake module path: +# +LIST(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake") + + +###################################################### +# Paths for installation: +# +INCLUDE(GNUInstallDirs) +IF(NOT DEFINED BT_BINDIR) + SET(BT_BINDIR "${CMAKE_INSTALL_BINDIR}") +ENDIF() +IF(NOT DEFINED BT_DATAROOTDIR) + SET(BT_DATAROOTDIR "${CMAKE_INSTALL_DATAROOTDIR}") +ENDIF() +IF(NOT DEFINED BT_DATADIR) + SET(BT_DATADIR "${CMAKE_INSTALL_DATADIR}") +ENDIF() +IF(NOT DEFINED SWORD_DATADIR) + SET(SWORD_DATADIR "${BT_DATAROOTDIR}") +ENDIF() +IF(NOT DEFINED BT_DOCDIR) + SET(BT_DOCDIR "${CMAKE_INSTALL_DOCDIR}") +ENDIF() +IF(IS_ABSOLUTE "${BT_DOCDIR}") + SET(BT_DOCDIR_ABSOLUTE "${BT_DOCDIR}") +ELSE() + SET(BT_DOCDIR_ABSOLUTE "${CMAKE_INSTALL_PREFIX}/${BT_DOCDIR}") +ENDIF() +IF(NOT DEFINED BT_LOCALEDIR) + # The default for the BT_LOCALEDIR variable differs from the default of + # localedir in the GNU Coding Standards. + SET(BT_LOCALEDIR "${BT_DATADIR}/bibletime/locale") +ENDIF() + + +###################################################### +# The BibleTime application: +# +IF(BUILD_BIBLETIME) + INCLUDE("${CMAKE_CURRENT_SOURCE_DIR}/cmake/BTApplication.cmake") +ENDIF() + +###################################################### +# Documentation: +# +INCLUDE("${CMAKE_CURRENT_SOURCE_DIR}/cmake/BTDocumentation.cmake") + + +###################################################### +# "fix_cpp_headers" target to fix those copyright headers of files. +# +STRING(TIMESTAMP CURRENT_YEAR "%Y") +CONFIGURE_FILE("${CMAKE_CURRENT_SOURCE_DIR}/FILE_HEADER.cpp.in" + "${CMAKE_CURRENT_BINARY_DIR}/FILE_HEADER.cpp" @ONLY) +ADD_CUSTOM_TARGET(fix_cpp_headers + find "${CMAKE_CURRENT_SOURCE_DIR}" + -path "${CMAKE_CURRENT_SOURCE_DIR}/.git" -prune -o + -path "${CMAKE_CURRENT_BINARY_DIR}" -prune -o + -type f "\\(" -name "'*.h'" -o -name "'*.cpp'" -o -name "'*.qml'" "\\)" + -exec "${CMAKE_CURRENT_SOURCE_DIR}/cmake/fix_cpp_header.sh" "{}" + "${CMAKE_CURRENT_BINARY_DIR}/FILE_HEADER.cpp" "\\;") diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..08c7eed --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,8 @@ +# Code of Conduct + + 1. Love the Lord your God with all your heart, and with all your soul, and with all your mind. + 2. Love your neighbor as yourself. + +## References + + * Matthew 22:37-39 diff --git a/FILE_HEADER.cpp.in b/FILE_HEADER.cpp.in new file mode 100644 index 0000000..63f65dd --- /dev/null +++ b/FILE_HEADER.cpp.in @@ -0,0 +1,12 @@ +/********* +* +* In the name of the Father, and of the Son, and of the Holy Spirit. +* +* This file is part of BibleTime's source code, https://bibletime.info/ +* +* Copyright 1999-@CURRENT_YEAR@ by the BibleTime developers. +* The BibleTime source code is licensed under the GNU General Public License +* version 2.0. +* +**********/ + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d511905 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..cadf478 --- /dev/null +++ b/README.md @@ -0,0 +1,77 @@ +README for BibleTime +==================== + +BibleTime is a Bible study application based on the Sword library and +Qt toolkit. + +## INSTALLATION + +You can just download and install BibleTime from +[GitHub](https://github.com/bibletime/bibletime/releases/latest). +The following requirements are needed only if you want to develop BibleTime. + +### BUILD REQUIREMENTS + - A C++17 compiler. + - [Qt 6.7+](https://www.qt.io) (built against ICU) + - [Sword 1.8.1+](https://crosswire.org/sword) (built against ICU) + - [CLucene 2.0+](https://clucene.sf.net) + - [CMake 3.25+](https://cmake.org) + - [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/) (or + [pkgconf](https://gitea.treehouse.systems/ariadne/pkgconf)) + +### DOCUMENTATION GENERATION REQUIREMENTS (OPTIONAL) + - [docbook-xml](https://docbook.org/) + - [docbook-xsl](https://github.com/docbook/wiki/wiki/DocBookXslStylesheets) + - [fop](https://xmlgraphics.apache.org/fop/) (for PDF generation) + - [po4a](https://po4a.org/) + - [xsltproc](https://gitlab.gnome.org/GNOME/libxslt) + +These packages are only used by the build system when document generation and +installation is enabled. By default, all translations of the handbook and howto +documents are generated and installed. This can be changed using the following +options to CMake: + + * `BUILD_HANDBOOK_HTML` - whether to generate and install the HTML handbook + (default: "ON") + * `BUILD_HANDBOOK_HTML_LANGUAGES` + - list of language codes to use for HTML handbook, or empty for all + languages (default: "") + * `BUILD_HANDBOOK_PDF` - whether to generate and install the PDF handbook + (default: "ON") + * `BUILD_HANDBOOK_PDF_LANGUAGES` + - list of language codes to use for PDF handbook, or empty for all + languages (default: "") + * `BUILD_HOWTO_HTML` - whether to generate and install the HTML howto (default: + "ON") + * `BUILD_HOWTO_HTML_LANGUAGES` + - list of language codes to use for HTML howto, or empty for all + languages (default: "") + * `BUILD_HOWTO_PDF` - whether to generate and install the PDF howto (default: + "ON") + * `BUILD_HOWTO_PDF_LANGUAGES` + - list of language codes to use for PDF howto, or empty for all languages + (default: "") + +For example, passing `-DGENERATE-HOWTO_HTML_LANGUAGES=en;et` to the cmake +command to restricts generation and installation of howto HTML versions to the +English and Estonian translations only, and `-DBUILD_HOWTO_PDF=OFF` disables +generation of the howto in PDF format. + + +## FEEDBACK + +Please report any bugs you find to +[our issue tracker](https://github.com/bibletime/bibletime/issues) +or see [the BibleTime homepage](https://bibletime.info/) for additional information. + +## DOCUMENTATION + +You can find information about BibleTime, the installation +and its usage in the following places: + - https://bibletime.info/ + - The BibleTime handbook available in the Help menu of the BibleTime application. + - There's a Bible study tutorial in the help menu. + +May God, our Lord, use BibleTime for his glory. + +The BibleTime developers diff --git a/cmake/BTApplication.cmake b/cmake/BTApplication.cmake new file mode 100644 index 0000000..33b00ea --- /dev/null +++ b/cmake/BTApplication.cmake @@ -0,0 +1,252 @@ +###################################################### +# Find packages: +# +SET(QT_REQUIRED_COMPONENTS + Core + Gui + LinguistTools + Widgets + Xml + Test + Svg + PrintSupport + Qml + Quick + QuickWidgets +) +IF(BUILD_TEXT_TO_SPEECH) + LIST(APPEND QT_REQUIRED_COMPONENTS TextToSpeech) +ENDIF() +FIND_PACKAGE(Qt6 6.7 REQUIRED COMPONENTS ${QT_REQUIRED_COMPONENTS}) +MESSAGE(STATUS "Found Qt6: ${Qt6_VERSION}") +GET_TARGET_PROPERTY(QT_ENABLED_PRIVATE_FEATURES Qt6::Core + QT_ENABLED_PRIVATE_FEATURES) +IF("icu" IN_LIST QT_ENABLED_PRIVATE_FEATURES) + MESSAGE(STATUS "Qt6 found seems to have required ICU support.") +ELSE() + MESSAGE(FATAL_ERROR "Qt6 found seems to lack required ICU support!") +ENDIF() +FIND_PACKAGE(PkgConfig REQUIRED) +pkg_search_module(Sword REQUIRED IMPORTED_TARGET sword>=1.8.1) +MESSAGE(STATUS "Found Sword: ${Sword_VERSION}") +pkg_search_module(CLucene REQUIRED IMPORTED_TARGET libclucene-core>=2.3.3.4) +MESSAGE(STATUS "Found CLucene: ${CLucene_VERSION}") + +###################################################### +# Build options, definitions, linker flags etc for all targets: +# +IF(NOT (DEFINED BT_RUNTIME_DOCDIR)) + IF(MSVC) + SET(BT_RUNTIME_DOCDIR "${BT_DOCDIR}") + ELSE() + SET(BT_RUNTIME_DOCDIR "${BT_DOCDIR_ABSOLUTE}") + ENDIF() +ENDIF() + +SET(CMAKE_AUTOMOC ON) +IF("${CMAKE_BUILD_TYPE}" STREQUAL "Release") + SET(CMAKE_AUTOMOC_MOC_OPTIONS "-DNDEBUG") +ENDIF() + +FILE(GLOB_RECURSE bibletime_SOURCES CONFIGURE_DEPENDS + "${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp" + "${CMAKE_CURRENT_SOURCE_DIR}/src/*.h" +) +FILE(GLOB_RECURSE bibletime_QML_FILES CONFIGURE_DEPENDS + "${CMAKE_CURRENT_SOURCE_DIR}/src/*.qml" +) +IF(MSVC) + ADD_EXECUTABLE("bibletime" WIN32 ${bibletime_SOURCES} "cmake/BTWinIcon.rc") +ELSE() + ADD_EXECUTABLE("bibletime" ${bibletime_SOURCES}) +ENDIF() +TARGET_COMPILE_FEATURES("bibletime" PRIVATE cxx_std_17) +TARGET_COMPILE_DEFINITIONS("bibletime" PRIVATE + "BT_RUNTIME_DOCDIR=\"${BT_RUNTIME_DOCDIR}\"" + "BT_VERSION=\"${PROJECT_VERSION}\"" + "BT_HOMEPAGE=\"${PROJECT_HOMEPAGE}\"" + "QT_NO_KEYWORDS" + "QT_DISABLE_DEPRECATED_UP_TO=0x060500" + "$<$:SWUSINGDLL>" + "$<$:_UNICODE>" + "$<$:UNICODE>" + "$<$:NDEBUG>" + "$<$:QT_NO_DEBUG>" +) +IF(BUILD_TEXT_TO_SPEECH) + TARGET_COMPILE_DEFINITIONS("bibletime" PRIVATE "BUILD_TEXT_TO_SPEECH") +ENDIF() +TARGET_COMPILE_OPTIONS("bibletime" PRIVATE + "$<$:/W1>" + "$<$:/Zi>" + "$<$:/Zc:wchar_t>" + "$<$,$>:/MD>" + "$<$,$>:/MDd>" + "$<$,$>:/Od>" + "$<$>:-Wall>" + "$<$>:-Wextra>" + "$<$>:-fPIE>" + "$<$>:-fexceptions>" +) +TARGET_INCLUDE_DIRECTORIES("bibletime" PRIVATE + ${CMAKE_CURRENT_BINARY_DIR} + + # work around QTBUG-87221/QTBUG-93443: + "${CMAKE_CURRENT_SOURCE_DIR}/src/frontend/display/modelview/" +) +TARGET_LINK_LIBRARIES("bibletime" PRIVATE + PkgConfig::CLucene + PkgConfig::Sword + Qt::Network + Qt::PrintSupport + Qt::Quick + Qt::QuickWidgets + Qt::Svg + Qt::Widgets + Qt::Xml +) +IF(BUILD_TEXT_TO_SPEECH) + TARGET_LINK_LIBRARIES("bibletime" PRIVATE Qt::TextToSpeech) +ENDIF() +SET_TARGET_PROPERTIES("bibletime" PROPERTIES CXX_EXTENSIONS NO) + +SET(CMAKE_REQUIRED_QUIET TRUE) +INCLUDE(CheckIPOSupported) +CHECK_IPO_SUPPORTED(RESULT HAVE_IPO) +MESSAGE(STATUS "Using interprocedural optimization: ${HAVE_IPO}") +IF(HAVE_IPO) + SET_TARGET_PROPERTIES("bibletime" PROPERTIES + INTERPROCEDURAL_OPTIMIZATION TRUE) +ENDIF() + +INCLUDE(CheckCXXCompilerFlag) +FOREACH(flag IN ITEMS + "-Walloca" + "-Wextra-semi" + "-Wformat=2" + "-Wformat-signedness" + "-Wfloat-equal" + "-Wformat" + "-Wlogical-op" + "-Wno-packed" + "-Wno-padded" + "-Wno-switch-enum" + "-Wpointer-arith" + "-Wsuggest-destructor-override" + "-Wsuggest-override" + "-Wunused-parameter" + "-Wzero-as-null-pointer-constant" + "-fasynchronous-unwind-tables" + "-fcf-protection=full" + "-fstack-clash-protection" + "-fstack-protector-strong" + "-pipe" +) + STRING(SHA512 flag_id "${flag}") + CHECK_CXX_COMPILER_FLAG("${flag}" "cxx_compiler_has_flag_${flag_id}") + IF("${cxx_compiler_has_flag_${flag_id}}") + TARGET_COMPILE_OPTIONS("bibletime" PRIVATE "${flag}") + MESSAGE(STATUS "Using C++ compiler flag: ${flag}") + ELSE() + MESSAGE(STATUS "Flag not supported by C++ compiler: ${flag}") + ENDIF() +ENDFOREACH() + +FOREACH(file IN LISTS bibletime_QML_FILES) + STRING(REGEX REPLACE "^.*/([^/]+)$" "\\1" filename "${file}") + SET_SOURCE_FILES_PROPERTIES("${file}" PROPERTIES + QT_RESOURCE_ALIAS "${filename}") +ENDFOREACH() +QT_ADD_QML_MODULE("bibletime" + URI "BibleTime" + RESOURCE_PREFIX "/qt/qml" + NO_RESOURCE_TARGET_PATH + VERSION 1.0 + QML_FILES ${bibletime_QML_FILES} +) + + +###################################################### +# Define rules to generate and install translation files: +# +FILE(GLOB BT_TS_FILES CONFIGURE_DEPENDS + "${CMAKE_CURRENT_SOURCE_DIR}/i18n/messages/bibletime_ui_*.ts" +) +qt_add_translations("bibletime" + SOURCE_TARGETS "bibletime" + TS_FILES ${BT_TS_FILES} + QM_FILES_OUTPUT_VARIABLE BT_QM_FILES + LUPDATE_TARGET "lupdate" + LRELEASE_TARGET "lrelease" +) +INSTALL(FILES ${BT_QM_FILES} DESTINATION "${BT_LOCALEDIR}/") + + +###################################################### +# Installation: +# +INSTALL(TARGETS "bibletime" DESTINATION "${BT_BINDIR}") +FILE(GLOB INSTALL_ICONS_LIST CONFIGURE_DEPENDS + "${CMAKE_CURRENT_SOURCE_DIR}/pics/icons/*.svg") +INSTALL(FILES ${INSTALL_ICONS_LIST} + DESTINATION "${BT_DATADIR}/bibletime/icons/") +FILE(GLOB INSTALL_ICONS_LIST_PNG CONFIGURE_DEPENDS + "${CMAKE_CURRENT_SOURCE_DIR}/pics/icons/bibletime.png") +INSTALL(FILES ${INSTALL_ICONS_LIST_PNG} + DESTINATION "${BT_DATADIR}/bibletime/icons/") + +INSTALL(FILES "LICENSE" + DESTINATION "${BT_DATADIR}/bibletime/license/") + +FILE(GLOB INSTALL_TMPL_LIST CONFIGURE_DEPENDS + "${CMAKE_CURRENT_SOURCE_DIR}/src/display-templates/*.css" + "${CMAKE_CURRENT_SOURCE_DIR}/src/display-templates/*.cmap" + "${CMAKE_CURRENT_SOURCE_DIR}/src/display-templates/Basic.tmpl" + "${CMAKE_CURRENT_SOURCE_DIR}/src/display-templates/basic_template.txt") +INSTALL(FILES ${INSTALL_TMPL_LIST} + DESTINATION "${BT_DATADIR}/bibletime/display-templates/") +INSTALL(FILES "pics/startuplogo.png" "pics/startuplogo_christmas.png" + "pics/startuplogo_easter.jpg" + DESTINATION "${BT_DATADIR}/bibletime/pics/") + +# Platform specific installation + +# Linux: application icon and desktop file: +INSTALL(FILES "${CMAKE_CURRENT_SOURCE_DIR}/pics/icons/bibletime.svg" + DESTINATION "${BT_DATAROOTDIR}/icons/hicolor/scalable/apps" RENAME "info.bibletime.BibleTime.svg") + + +CONFIGURE_FILE("${CMAKE_CURRENT_SOURCE_DIR}/cmake/platforms/linux/bibletime.desktop.cmake" + "${CMAKE_CURRENT_BINARY_DIR}/bibletime.desktop" @ONLY) +INSTALL(FILES "${CMAKE_CURRENT_BINARY_DIR}/bibletime.desktop" + DESTINATION "${BT_DATAROOTDIR}/applications/" RENAME "info.bibletime.BibleTime.desktop") + + +CONFIGURE_FILE("${CMAKE_CURRENT_SOURCE_DIR}/cmake/platforms/linux/info.bibletime.BibleTime.metainfo.xml" + "${CMAKE_CURRENT_BINARY_DIR}/info.bibletime.BibleTime.metainfo.xml" @ONLY) +INSTALL(FILES "${CMAKE_CURRENT_BINARY_DIR}/info.bibletime.BibleTime.metainfo.xml" + DESTINATION "${BT_DATAROOTDIR}/metainfo/") + + + +IF(MSVC) # Windows: + # sword locale information + FILE(GLOB INSTALL_SWORD_LOCALE_LIST CONFIGURE_DEPENDS + "${Sword_INCLUDE_DIRS}/../../share/sword/locales.d/*") + INSTALL(FILES ${INSTALL_SWORD_LOCALE_LIST} + DESTINATION "${SWORD_DATADIR}/sword/locales.d/") + + # install pdb file for debugging purposes + IF(CMAKE_BUILD_TYPE STREQUAL "Debug") + SET(bibletime_PDB "${bibletime_BINARY_DIR}/Debug/bibletime.pdb") + INSTALL(FILES "${bibletime_PDB}" DESTINATION "${BT_BINDIR}") + ENDIF() +ENDIF() + + +###################################################### +# Binary packages: +# +IF(WIN32 AND NOT UNIX) + INCLUDE("${CMAKE_CURRENT_SOURCE_DIR}/cmake/BTBinaryPackageWindows.cmake") +ENDIF() diff --git a/cmake/BTBinaryPackageWindows.cmake b/cmake/BTBinaryPackageWindows.cmake new file mode 100755 index 0000000..a796bb7 --- /dev/null +++ b/cmake/BTBinaryPackageWindows.cmake @@ -0,0 +1,100 @@ +IF(WIN32 AND NOT UNIX) + + # Libs needed for packaging + FIND_PACKAGE(ZLIB REQUIRED) + FIND_PACKAGE(CURL REQUIRED) + FIND_PACKAGE(Sword REQUIRED) + + SET(CPACK_PACKAGE_NAME "BibleTime") + SET(CPACK_PACKAGE_DESCRIPTION_SUMMARY "BibleTime for Windows") + SET(CPACK_PACKAGE_VENDOR "https://bibletime.info") + SET(CPACK_PACKAGE_VERSION_MAJOR ${PROJECT_VERSION_MAJOR}) + SET(CPACK_PACKAGE_VERSION_MINOR ${PROJECT_VERSION_MINOR}) + SET(CPACK_PACKAGE_VERSION_PATCH ${PROJECT_VERSION_PATCH}) + SET(CPACK_PACKAGE_INSTALL_DIRECTORY "BibleTime") + + SET(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE") + + # We need the libraries, and they're not pulled in automatically + SET(CMAKE_INSTALL_DEBUG_LIBRARIES TRUE) + + SET(QT_BINARY_DIR "${QT_DIR}/../../../bin") + INSTALL(DIRECTORY + "${QT_BINARY_DIR}/../translations" + DESTINATION "${BT_BINDIR}" + CONFIGURATIONS "Release" + ) + + FIND_PROGRAM(QT_WINDEPLOYQT_EXECUTABLE windeployqt HINTS "${QT_BIN_DIR}") + MESSAGE(STATUS "Running ${QT_WINDEPLOYQT_EXECUTABLE}") + INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${QT_WINDEPLOYQT_EXECUTABLE} -qmldir \"${CMAKE_CURRENT_SOURCE_DIR}/src/frontend/display/modelview/\" \"\${CMAKE_INSTALL_PREFIX}/bin/bibletime.exe\") ") + + IF(CMAKE_BUILD_TYPE STREQUAL "Debug") + SET(ZLIB_LIBRARY ${ZLIB_LIBRARY_DEBUG}) + ELSE() + SET(ZLIB_LIBRARY ${ZLIB_LIBRARY_RELEASE}) + ENDIF() + + SET(ICU_DT_DLL ${CMAKE_INSTALL_PREFIX}/bin/icudt74.dll) + MESSAGE(STATUS "INSTALL icudt_DLL ${ICU_DT_DLL}" ) + INSTALL(FILES ${ICU_DT_DLL} DESTINATION ${BT_BINDIR}) + + SET(ICU_IN_DLL ${CMAKE_INSTALL_PREFIX}/bin/icuin74.dll) + MESSAGE(STATUS "INSTALL icuin_DLL ${ICU_IN_DLL}" ) + INSTALL(FILES ${ICU_IN_DLL} DESTINATION ${BT_BINDIR}) + + SET(ICU_IO_DLL ${CMAKE_INSTALL_PREFIX}/bin/icuio74.dll) + MESSAGE(STATUS "INSTALL icuio_DLL ${ICU_IO_DLL}" ) + INSTALL(FILES ${ICU_IO_DLL} DESTINATION ${BT_BINDIR}) + + SET(ICU_TU_DLL ${CMAKE_INSTALL_PREFIX}/bin/icutu74.dll) + MESSAGE(STATUS "INSTALL icutu_DLL ${ICU_TU_DLL}" ) + INSTALL(FILES ${ICU_TU_DLL} DESTINATION ${BT_BINDIR}) + + SET(ICU_UC_DLL ${CMAKE_INSTALL_PREFIX}/bin/icuuc74.dll) + MESSAGE(STATUS "INSTALL icuuc_DLL ${ICU_UC_DLL}" ) + INSTALL(FILES ${ICU_UC_DLL} DESTINATION ${BT_BINDIR}) + + MESSAGE(STATUS "INSTALL Zlib_LIBRARY ${ZLIB_LIBRARY}" ) + STRING(REPLACE ".lib" ".dll" ZLIB_DLL "${ZLIB_LIBRARY}") + INSTALL(FILES ${ZLIB_DLL} DESTINATION ${BT_BINDIR}) + + MESSAGE(STATUS "INSTALL CLucene_LIBRARY ${CLucene_LIBRARY}" ) + STRING(REPLACE ".lib" ".dll" CLUCENE_DLL "${CLucene_LIBRARY}") + INSTALL(FILES ${CLUCENE_DLL} DESTINATION ${BT_BINDIR}) + + MESSAGE(STATUS "INSTALL CLucene_LIBRARY ${CLucene_SHARED_LIB}" ) + STRING(REPLACE ".lib" ".dll" CLUCENE_SHARED_DLL "${CLucene_SHARED_LIB}") + INSTALL(FILES ${CLUCENE_SHARED_DLL} DESTINATION ${BT_BINDIR}) + + MESSAGE(STATUS "INSTALL CURL_LIBRARY ${CURL_LIBRARY}" ) + STRING(REPLACE "_imp.lib" ".dll" CURL_DLL "${CURL_LIBRARY}") + INSTALL(FILES ${CURL_DLL} DESTINATION ${BT_BINDIR}) + + SET(SWORD_DLL "${Sword_LIBRARY_DIRS}/sword.dll") + MESSAGE(STATUS "INSTALL SWORD_LIBRARY ${SWORD_DLL}" ) + INSTALL(FILES ${SWORD_DLL} DESTINATION ${BT_BINDIR}) + + # Some options for the CPack system. These should be pretty self-evident + SET(CPACK_PACKAGE_ICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\pics\\\\icons\\\\bibletime.png") + SET(CPACK_NSIS_INSTALLED_ICON_NAME "bin\\\\bibletime.exe") + SET(CPACK_NSIS_DISPLAY_NAME "${CPACK_PACKAGE_INSTALL_DIRECTORY}") + SET(CPACK_NSIS_HELP_LINK "https:\\\\\\\\bibletime.info") + SET(CPACK_NSIS_URL_INFO_ABOUT "https:\\\\\\\\bibletime.info") + SET(CPACK_NSIS_CONTACT "bt-devel@crosswire.org") + SET(CPACK_NSIS_MODIFY_PATH OFF) + SET(CPACK_GENERATOR "NSIS") + + SET(CPACK_PACKAGE_EXECUTABLES "bibletime" "BibleTime") + + # This adds in the required Windows system libraries + MESSAGE(STATUS "INSTALL Microsoft Redist ${MSVC_REDIST}" ) + SET(CPACK_NSIS_EXTRA_INSTALL_COMMANDS " + ExecWait \\\"$INSTDIR\\\\bin\\\\vcredist_x86.exe /q\\\" + Delete \\\"$INSTDIR\\\\bin\\\\vcredist_x86.exe\\\" + ") + + INCLUDE(CPack) + +ENDIF(WIN32 AND NOT UNIX) + diff --git a/cmake/BTDocumentation.cmake b/cmake/BTDocumentation.cmake new file mode 100644 index 0000000..7ad69fb --- /dev/null +++ b/cmake/BTDocumentation.cmake @@ -0,0 +1,348 @@ +###################################################### +# Some helper variables: +# +MACRO(ToggleOnOff out) + IF(${ARGN}) + SET("${out}" ON) + ELSE() + SET("${out}" OFF) + ENDIF() +ENDMACRO() +ToggleOnOff("BUILD_HTML" BUILD_HANDBOOK_HTML OR BUILD_HOWTO_HTML) +ToggleOnOff("BUILD_PDF" BUILD_HANDBOOK_PDF OR BUILD_HOWTO_PDF) +ToggleOnOff("BUILD_HANDBOOK" BUILD_HANDBOOK_HTML OR BUILD_HANDBOOK_PDF) +ToggleOnOff("BUILD_HOWTO" BUILD_HOWTO_HTML OR BUILD_HOWTO_PDF) +ToggleOnOff("BUILD_DOCS" BUILD_HTML OR BUILD_PDF) +SET(DOCS_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/docs") + +###################################################### + +IF(INSTALL_GENERATED_DOCS) + INSTALL(DIRECTORY ${GENERATED_DOCS_DIR}/handbook DESTINATION ${BT_DOCDIR}) + INSTALL(DIRECTORY ${GENERATED_DOCS_DIR}/howto DESTINATION ${BT_DOCDIR}) +ENDIF() + + +###################################################### +# Return if nothing to do: +# +IF(NOT BUILD_DOCS) + RETURN() +ENDIF() + + +###################################################### +# Find dependencies +# +MACRO(FIND_REQUIRED_PROGRAM var name) + FIND_PROGRAM("${var}" "${name}" ${ARGN}) + IF(NOT ${var}) + MESSAGE(FATAL_ERROR "Required program \"${name}\" not found!") + ELSE() + MESSAGE(STATUS "Found ${name}: ${${var}}") + ENDIF() +ENDMACRO() +FIND_REQUIRED_PROGRAM(PO4A_COMMAND po4a) +FIND_REQUIRED_PROGRAM(XSLTPROC_COMMAND xsltproc) +IF(BUILD_PDF) + FIND_REQUIRED_PROGRAM(FOP_COMMAND fop) +ENDIF() + + +###################################################### +# Scan for handbook and howto translations: +# +FUNCTION(NewUniqueSortedList out) + SET(r tmp) + LIST(REMOVE_ITEM r tmp) + LIST(APPEND r ${ARGN}) + LIST(SORT r) + LIST(REMOVE_DUPLICATES r) + SET("${out}" "${r}" PARENT_SCOPE) +ENDFUNCTION() +FUNCTION(GetDocLangs type out) + NewUniqueSortedList(outList) + SET(l "[abcdefghijklmnopqrstuvwxyz]") + SET(u "[ABCDEFGHIJKLMNOPQRSTUVWXYZ]") + SET(regex "^${l}${l}(_${u}${u}${u}?)?$") + FILE(GLOB files CONFIGURE_DEPENDS + "${CMAKE_CURRENT_SOURCE_DIR}/i18n/${type}/${type}-*.po") + FOREACH(file IN LISTS files) + GET_FILENAME_COMPONENT(basename "${file}" NAME_WE) + STRING(REGEX REPLACE "^${type}-" "" basename "${basename}") + IF(("${basename}" MATCHES "${regex}") + AND NOT (IS_DIRECTORY "${file}")) + LIST(APPEND outList "${basename}") + ENDIF() + ENDFOREACH() + NewUniqueSortedList(outList "en" ${outList}) + SET("${out}" "${outList}" PARENT_SCOPE) +ENDFUNCTION() +FUNCTION(GetDocArtifacts doc) + STRING(TOUPPER "${doc}" udoc) + NewUniqueSortedList(images) + SET(imageDir "${CMAKE_CURRENT_SOURCE_DIR}/docs/${doc}/images") + IF(IS_DIRECTORY "${imageDir}") + FILE(GLOB images CONFIGURE_DEPENDS "${imageDir}/*") + ENDIF() + SET("${udoc}_IMAGES" "${images}" PARENT_SCOPE) +ENDFUNCTION() +FUNCTION(CheckMissingTranslations doc type) + STRING(TOUPPER "${doc}" udoc) + IF(BUILD_${udoc}_${type}) + SET(in "BUILD_${udoc}_${type}_LANGUAGES") + SET(available ${AVAILABLE_${udoc}_LANGUAGES}) + SET(out "DO_${in}") + SET(in "${${in}}") + IF("${in}" STREQUAL "") + SET("${out}" "${available}" PARENT_SCOPE) + STRING(REPLACE ";" " " available "${available}") + MESSAGE(STATUS + "Languages for ${doc} (${type}): ${available}") + ELSE() + LIST(SORT in) + FOREACH(lang IN LISTS in) + IF(NOT ("${lang}" IN_LIST available)) + MESSAGE(FATAL_ERROR + "Language for ${doc} (${type}) not found: ${lang}") + ENDIF() + LIST(REMOVE_ITEM available "${lang}") + ENDFOREACH() + SET("${out}" "${in}" PARENT_SCOPE) + STRING(REPLACE ";" " " in "${in}") + IF(NOT ("${available}" STREQUAL "")) + STRING(REPLACE ";" " -" available ";${available}") + ENDIF() + MESSAGE(STATUS + "Languages for ${doc} (${type}): ${in}${available}") + ENDIF() + ENDIF() +ENDFUNCTION() +IF(BUILD_HANDBOOK) + GetDocLangs("handbook" AVAILABLE_HANDBOOK_LANGUAGES) + GetDocArtifacts("handbook") + CheckMissingTranslations("handbook" "HTML") + CheckMissingTranslations("handbook" "PDF") + NewUniqueSortedList(BUILD_HANDBOOK_LANGUAGES + ${DO_BUILD_HANDBOOK_HTML_LANGUAGES} + ${DO_BUILD_HANDBOOK_PDF_LANGUAGES}) +ENDIF() +IF(BUILD_HOWTO) + GetDocLangs("howto" AVAILABLE_HOWTO_LANGUAGES) + GetDocArtifacts("howto") + CheckMissingTranslations("howto" "HTML") + CheckMissingTranslations("howto" "PDF") + NewUniqueSortedList(BUILD_HOWTO_LANGUAGES + ${DO_BUILD_HOWTO_HTML_LANGUAGES} + ${DO_BUILD_HOWTO_PDF_LANGUAGES}) +ENDIF() +NewUniqueSortedList(ALL_DOC_LANGUAGES + ${BUILD_HANDBOOK_LANGUAGES} + ${BUILD_HOWTO_LANGUAGES}) + + +###################################################### +# General documentation targets generation: +# +FUNCTION(AddDocTarget name) + ADD_CUSTOM_TARGET("${name}" DEPENDS ${ARGN}) + SET_TARGET_PROPERTIES("${name}" PROPERTIES FOLDER "Documentation") +ENDFUNCTION() +AddDocTarget("docs") +SET_TARGET_PROPERTIES("docs" PROPERTIES EXCLUDE_FROM_ALL FALSE) +FUNCTION(AddDocSubTarget parent name) + IF(NOT TARGET "${name}") + AddDocTarget("${name}" ${ARGN}) + ADD_DEPENDENCIES("${parent}" "${name}") + ELSEIF(NOT ("${ARGN}" STREQUAL "")) + ADD_DEPENDENCIES("${name}" ${ARGN}) + ENDIF() +ENDFUNCTION() + + +###################################################### +# Generate po4a configurations and targets for handbook and howto: +# +FUNCTION(BUILD_PO4A_CONF_AND_TARGET doc) + STRING(TOUPPER "${doc}" udoc) + IF(BUILD_${udoc}) + AddDocTarget("${doc}_translations") + SET(docbookInputDir "${CMAKE_CURRENT_SOURCE_DIR}/docs/${doc}/docbook") + FILE(GLOB_RECURSE inputs CONFIGURE_DEPENDS "${docbookInputDir}/*") + AddDocSubTarget("${doc}_translations" "${doc}_translation_en" + "${inputs}") + + SET(generatedLanguages "${BUILD_${udoc}_LANGUAGES}") + LIST(REMOVE_ITEM generatedLanguages "en") + SET(po4aDirBase "${DOCS_BINARY_DIR}/${doc}/po4a") + SET(docbookDirBase "${DOCS_BINARY_DIR}/${doc}/docbook") + FOREACH(l IN LISTS generatedLanguages) + FILE(MAKE_DIRECTORY "${po4aDirBase}/${l}") + SET(docbookDir "${docbookDirBase}/${l}") + FILE(MAKE_DIRECTORY "${docbookDir}") + SET(confFile "${po4aDirBase}/${l}/po4a.conf") + FILE(WRITE "${confFile}" + "[po4a_langs] ${l} +[po4a_paths] ${CMAKE_CURRENT_SOURCE_DIR}/i18n/${doc}/${doc}.pot \ +$lang:${CMAKE_CURRENT_SOURCE_DIR}/i18n/${doc}/${doc}-$lang.po\n") + FOREACH(input IN LISTS inputs) + FILE(RELATIVE_PATH relativeInput "${docbookInputDir}" + "${input}") + FILE(APPEND "${confFile}" + "[type: docbook] ${docbookInputDir}/${relativeInput} \ +\$lang:${docbookDirBase}/\$lang/${relativeInput}\n") + ENDFOREACH() + SET(stampFile "${docbookDir}/stamp") + ADD_CUSTOM_COMMAND(OUTPUT "${stampFile}" + COMMAND "${PO4A_COMMAND}" --verbose --no-backups --keep 0 + --porefs never "${confFile}" + COMMAND "${CMAKE_COMMAND}" -E touch "${stampFile}" + DEPENDS "${confFile}" ${inputs}) + AddDocSubTarget("${doc}_translations" "${doc}_translation_${l}" + "${stampFile}") + ENDFOREACH() + ENDIF() +ENDFUNCTION() +BUILD_PO4A_CONF_AND_TARGET("handbook") +BUILD_PO4A_CONF_AND_TARGET("howto") + + +###################################################### +# Rules for HTML: +# +IF(BUILD_HTML) + # Generate XSL files for HTML: + IF(NOT DEFINED BT_DOCBOOK_XSL_HTML_CHUNK_XSL) + FIND_FILE(BT_DOCBOOK_XSL_HTML_CHUNK_XSL + NAMES "chunk.xsl" + HINTS + "/usr/share/xml/docbook/stylesheet/docbook-xsl/html/" + "/usr/share/sgml/docbook/xsl-stylesheets/html/" + "/usr/share/xsl/docbook/html/" + "/usr/share/xml/docbook/stylesheet/nwalsh/html/" + "/usr/local/share/xml/docbook/stylesheet/docbook-xsl/html/" + "/usr/local/share/sgml/docbook/xsl-stylesheets/html/" + "/usr/local/share/xsl/docbook/html/" + "/usr/local/share/xml/docbook/stylesheet/nwalsh/html/" + NO_DEFAULT_PATH) + IF(NOT BT_DOCBOOK_XSL_HTML_CHUNK_XSL) + MESSAGE(FATAL_ERROR "The required file html/chunk.xsl from \ +docbook-xsl was not found on the system! Please specify its full path with \ +-DBT_DOCBOOK_XSL_HTML_CHUNK_XSL=path/to/html/chunk.xsl") + ELSE() + MESSAGE(STATUS "Found XSL for HTML generation: \ +${BT_DOCBOOK_XSL_HTML_CHUNK_XSL}") + ENDIF() + ENDIF() + SET(BT_DOCBOOK_XSL "${DOCS_BINARY_DIR}/docs.xsl") + CONFIGURE_FILE("${CMAKE_CURRENT_SOURCE_DIR}/cmake/docs/docs.xsl.in" + "${BT_DOCBOOK_XSL}" @ONLY) + + FUNCTION(GenerateHtmlDoc doc) + STRING(TOUPPER "${doc}" udoc) + IF(${BUILD_${udoc}_HTML}) + AddDocSubTarget("docs" "${doc}") + AddDocSubTarget("${doc}" "${doc}_html") + FOREACH(l IN LISTS "DO_BUILD_${udoc}_HTML_LANGUAGES") + SET(d "${DOCS_BINARY_DIR}/${doc}/html/${l}") + FILE(MAKE_DIRECTORY "${d}") + IF("${l}" STREQUAL "en") + SET(i "${CMAKE_CURRENT_SOURCE_DIR}/docs/${doc}/docbook") + ELSE() + SET(i "${DOCS_BINARY_DIR}/${doc}/docbook/${l}") + ENDIF() + SET(stampFile "${d}/.stamp") + ADD_CUSTOM_COMMAND(OUTPUT "${stampFile}" + COMMAND "${XSLTPROC_COMMAND}" --nonet --output "${d}/" + --stringparam l10n.gentext.default.language "${l}" + "${BT_DOCBOOK_XSL}" "${i}/index.docbook" + COMMAND "${CMAKE_COMMAND}" -E touch "${stampFile}" + DEPENDS "${doc}_translation_${l}") + AddDocSubTarget("${doc}_html" "${doc}_html_${l}" "${stampFile}") + INSTALL(DIRECTORY "${d}/" + DESTINATION "${BT_DOCDIR}/${doc}/html/${l}/" + PATTERN ".*" EXCLUDE) + INSTALL(FILES ${${udoc}_IMAGES} + DESTINATION "${BT_DOCDIR}/${doc}/html/${l}/") + ENDFOREACH() + ENDIF() + ENDFUNCTION() + GenerateHtmlDoc("handbook") + GenerateHtmlDoc("howto") +ENDIF() + +###################################################### +# Rules for PDF: +# +IF(BUILD_PDF) + # Generate XSL files for PDF: + IF(NOT DEFINED BT_DOCBOOK_XSL_PDF_DOCBOOK_XSL) + FIND_FILE(BT_DOCBOOK_XSL_PDF_DOCBOOK_XSL + NAMES "docbook.xsl" + HINTS + "/usr/share/xml/docbook/stylesheet/docbook-xsl/fo/" + "/usr/share/sgml/docbook/xsl-stylesheets/fo/" + "/usr/share/xsl/docbook/fo/" + "/usr/local/share/xml/docbook/stylesheet/docbook-xsl/fo/" + "/usr/local/share/sgml/docbook/xsl-stylesheets/fo/" + "/usr/local/share/xsl/docbook/fo/" + NO_DEFAULT_PATH) + IF(NOT BT_DOCBOOK_XSL_PDF_DOCBOOK_XSL) + MESSAGE(FATAL_ERROR "The required file fo/docbook.xsl from \ +docbook-xsl was not found on the system! Please specify its full path with \ +-DBT_DOCBOOK_XSL_PDF_DOCBOOK_XSL=path/to/fo/docbook.xsl") + ELSE() + MESSAGE(STATUS "Found XSL for PDF generation: \ +${BT_DOCBOOK_XSL_PDF_DOCBOOK_XSL}") + ENDIF() + ENDIF() + SET(BT_DOCBOOK_PDF_XSL "${DOCS_BINARY_DIR}/pdf.xsl") + CONFIGURE_FILE("${CMAKE_CURRENT_SOURCE_DIR}/cmake/docs/pdf.xsl.in" + "${BT_DOCBOOK_PDF_XSL}" @ONLY) + + FUNCTION(GeneratePdfDoc doc) + STRING(TOUPPER "${doc}" udoc) + IF(${BUILD_${udoc}_PDF}) + AddDocSubTarget("docs" "${doc}") + AddDocSubTarget("${doc}" "${doc}_xslfo") + AddDocSubTarget("${doc}" "${doc}_pdf") + FOREACH(l IN LISTS DO_BUILD_${udoc}_PDF_LANGUAGES) + SET(dx "${DOCS_BINARY_DIR}/${doc}/xslfo/${l}") + FILE(MAKE_DIRECTORY "${dx}") + IF("${l}" STREQUAL "en") + SET(i "${CMAKE_CURRENT_SOURCE_DIR}/docs/${doc}/docbook") + ELSE() + SET(i "${DOCS_BINARY_DIR}/${doc}/docbook/${l}") + ENDIF() + ADD_CUSTOM_COMMAND(OUTPUT "${dx}/${doc}.fo" + COMMENT "Generating ${dx}/${doc}.fo" + COMMAND "${XSLTPROC_COMMAND}" --nonet + --output "${dx}/${doc}.fo" + "${BT_DOCBOOK_PDF_XSL}" "${i}/index.docbook" + DEPENDS "${doc}_translation_${l}") + AddDocSubTarget("${doc}_xslfo" "${doc}_xslfo_${l}" + "${dx}/${doc}.fo") + + FOREACH(image IN LISTS "${udoc}_IMAGES") + GET_FILENAME_COMPONENT(imageName "${image}" NAME) + FILE(CREATE_LINK "${image}" "${dx}/${imageName}" + COPY_ON_ERROR) + ENDFOREACH() + + SET(dp "${DOCS_BINARY_DIR}/${doc}/pdf/${l}") + FILE(MAKE_DIRECTORY "${dp}") + ADD_CUSTOM_COMMAND(OUTPUT "${dp}/${doc}.pdf" + COMMENT "Generating ${dp}/${doc}.pdf" + COMMAND "${FOP_COMMAND}" -pdf "${dp}/${doc}.pdf" + -fo "${dx}/${doc}.fo" + DEPENDS "${doc}_xslfo_${l}") + AddDocSubTarget("${doc}_pdf" "${doc}_pdf_${l}" + "${dp}/${doc}.pdf" ${${udoc}_IMAGES}) + INSTALL(FILES "${dp}/${doc}.pdf" + DESTINATION "${BT_DOCDIR}/${doc}/pdf/${l}/") + ENDFOREACH() + ENDIF() + ENDFUNCTION() + GeneratePdfDoc("handbook") + GeneratePdfDoc("howto") +ENDIF() diff --git a/cmake/BTWinIcon.rc b/cmake/BTWinIcon.rc new file mode 100644 index 0000000..87a81e8 --- /dev/null +++ b/cmake/BTWinIcon.rc @@ -0,0 +1 @@ +IDI_ICON1 ICON DISCARDABLE "..\\pics\\icons\\bibletime.ico" \ No newline at end of file diff --git a/cmake/docs/docs.xsl.in b/cmake/docs/docs.xsl.in new file mode 100644 index 0000000..c23f1e7 --- /dev/null +++ b/cmake/docs/docs.xsl.in @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/cmake/docs/pdf.xsl.in b/cmake/docs/pdf.xsl.in new file mode 100644 index 0000000..9331339 --- /dev/null +++ b/cmake/docs/pdf.xsl.in @@ -0,0 +1,4 @@ + + + + diff --git a/cmake/fix_cpp_header.sh b/cmake/fix_cpp_header.sh new file mode 100755 index 0000000..41110f1 --- /dev/null +++ b/cmake/fix_cpp_header.sh @@ -0,0 +1,57 @@ +#!/bin/sh +set -euo pipefail + +ON_EXIT_ITEMS=() + +on_exit() { + while [ ${#ON_EXIT_ITEMS[*]} -ne 0 ]; do + eval "${ON_EXIT_ITEMS[${#ON_EXIT_ITEMS[@]}-1]}" + unset ON_EXIT_ITEMS[${#ON_EXIT_ITEMS[@]}-1] + done +} + +add_on_exit() { + local N=${#ON_EXIT_ITEMS[*]} + ON_EXIT_ITEMS["${N}"]="$*" + if [[ "${N}" -eq 0 ]]; then + trap on_exit EXIT + fi +} + +TARGETFILE="$1" +HEADER="$2" +TMPFILE=$(mktemp) +add_on_exit "rm -f '${TMPFILE}'" + +cat "$HEADER" > "$TMPFILE" + +awk ' + BEGIN { state = 0 } + + /^\/\*/ { + if (state == 0) { + state = 1 + } + } + + /\*\// { + if (state == 1) { + $0 = substr($0, index($0, "*/") + 2) + sub(/^[[:blank:]]*/, "") + state = 2 + } + } + + { + if (state != 1) { + print + state = 2 + } + } +' "$TARGETFILE" | \ +awk ' + BEGIN { state = 0 } + /^[[:blank:]]*$/ { if (state == 1) print } + /[^[:blank:]]/ { state = 1; print } +' >> "$TMPFILE" +cp -f "$TMPFILE" "$TARGETFILE" diff --git a/cmake/platforms/linux/bibletime.desktop.cmake b/cmake/platforms/linux/bibletime.desktop.cmake new file mode 100644 index 0000000..efdaba7 --- /dev/null +++ b/cmake/platforms/linux/bibletime.desktop.cmake @@ -0,0 +1,26 @@ +[Desktop Entry] +Comment=An easy to use bible study tool +Comment[C]=An easy to use bible study tool +Comment[cs]=Snadno použitelný nástroj pro studium Bible +Comment[da]=Et letanvendeligt bibelstudieprogram +Comment[de]=Ein einfach zu benutzendes Bibelprogramm +Comment[et]=Lihtne Piibliuurimise vahend +Comment[fi]=Helppokäyttöinen raamatunlukuohjelmisto +Comment[fr]=Un outil d'étude biblique facile à utiliser +Comment[it]=Un semplice strumento per studiare la Bibbia +Exec=bibletime +Icon=info.bibletime.BibleTime +Name=BibleTime @PROJECT_VERSION@ +Name[C]=BibleTime @PROJECT_VERSION@ +Name[cs]=BibleTime @PROJECT_VERSION@ +Name[da]=BibleTime @PROJECT_VERSION@ +Name[de]=BibleTime @PROJECT_VERSION@ +Name[et]=BibleTime @PROJECT_VERSION@ +Name[fr]=BibleTime @PROJECT_VERSION@ +Name[it]=BibleTime @PROJECT_VERSION@ +GenericName=Bible Study Tool +Terminal=false +Type=Application +Categories=X-Bible;X-Religion;Literature;Education;Dictionary;Qt; +Keywords=bible;study;religion;literature;education; +DocPath=bibletime/handbook/index.html diff --git a/cmake/platforms/linux/info.bibletime.BibleTime.metainfo.xml b/cmake/platforms/linux/info.bibletime.BibleTime.metainfo.xml new file mode 100644 index 0000000..bbda8f7 --- /dev/null +++ b/cmake/platforms/linux/info.bibletime.BibleTime.metainfo.xml @@ -0,0 +1,32 @@ + + + + info.bibletime.BibleTime.desktop + CC0-1.0 + GPL-2.0+ + BibleTime + Bible Study Program + +

BibleTime is an open-source cross-platform Bible study program.

+ + + https://bibletime.info/ + bt-devel@crosswire.org + + + https://bibletime.info/screenshots/BibleTime-Main-Screen.png + Main window + + + https://bibletime.info/screenshots/BibleTime-Search-Screen.png + Search window + + + + + +

See the website https://bibletime.info for more information.

+ + + + diff --git a/cmake/sword_version_print.cpp b/cmake/sword_version_print.cpp new file mode 100644 index 0000000..d555630 --- /dev/null +++ b/cmake/sword_version_print.cpp @@ -0,0 +1,27 @@ +/********* +* +* In the name of the Father, and of the Son, and of the Holy Spirit. +* +* This file is part of BibleTime's source code, https://bibletime.info/ +* +* Copyright 1999-2026 by the BibleTime developers. +* The BibleTime source code is licensed under the GNU General Public License +* version 2.0. +* +**********/ + +/* + * Check if Sword's current version is equal or larger than the version given to the program (first commandline argument) + */ + +#include +#include + +#ifndef SWORD_VERSION_STR +#error SWORD_VERSION_STR not defined! +#endif + +int main() { + std::cout << (SWORD_VERSION_STR); + return 0; +} diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..63eccbb --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +/doxygen diff --git a/docs/Doxyfile b/docs/Doxyfile new file mode 100644 index 0000000..dcb424e --- /dev/null +++ b/docs/Doxyfile @@ -0,0 +1,2493 @@ +# Doxyfile 1.8.17 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = BibleTime + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doxygen + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = YES + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is +# Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = YES + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = YES + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# (including Cygwin) ands Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = YES + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = YES + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = YES + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ../src/ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), +# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen +# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.cpp \ + *.h + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = NO + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: https://developer.apple.com/xcode/), introduced with OSX +# 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NONE + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /